<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libxlsxwriter: format.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libxlsxwriter
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9a5cb1f80a06fe707e78a539c1c1dae8.html">xlsxwriter</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">format.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>This section describes the functions and properties that are available for formatting cells in Excel.</p>
<p>The properties of a cell that can be formatted include: fonts, colors, patterns, borders, alignment and number formatting.</p>
<div class="image">
<img src="formats_intro.png" alt=""/>
</div>
<p>Formats in <code>libxlsxwriter</code> are accessed via the <a class="el" href="structlxw__format.html" title="Struct to represent the formatting properties of an Excel format.">lxw_format</a> struct. Throughout this document these will be referred to simply as <em>Formats</em>.</p>
<p>Formats are created by calling the <a class="el" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33" title="Create a new Format object to formats cells in worksheets.">workbook_add_format()</a> method as follows:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__format.html">lxw_format</a> *format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
</div><!-- fragment --><p>The members of the <a class="el" href="structlxw__format.html" title="Struct to represent the formatting properties of an Excel format.">lxw_format</a> struct aren't modified directly. Instead the format properties are set by calling the functions shown in this section. For example:</p>
<div class="fragment"><div class="line"><span class="comment">// Create the Format.</span></div>
<div class="line"><a class="code" href="structlxw__format.html">lxw_format</a> *format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set some of the format properties.</span></div>
<div class="line"><a class="code" href="format_8h.html#a85e1b0baf44b445b65894e48722aec14">format_set_bold</a>(format);</div>
<div class="line"><a class="code" href="format_8h.html#a61981b2080bfe6381ede5358ee05b05c">format_set_font_color</a>(format, <a class="code" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec">LXW_COLOR_RED</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Use the format to change the text format in a cell.</span></div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Hello&quot;</span>, format);</div>
</div><!-- fragment --><p>The full range of formatting options that can be applied using <code>libxlsxwriter</code> are shown below. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a449e2235a9088cc60233ae443acd2b1a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a449e2235a9088cc60233ae443acd2b1a">format_set_font_name</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, const char *font_name)</td></tr>
<tr class="memdesc:a449e2235a9088cc60233ae443acd2b1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the font used in the cell.  <a href="format_8h.html#a449e2235a9088cc60233ae443acd2b1a">More...</a><br /></td></tr>
<tr class="separator:a449e2235a9088cc60233ae443acd2b1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec5c1028fa3e25ad60e439fd64afb245"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#aec5c1028fa3e25ad60e439fd64afb245">format_set_font_size</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, double size)</td></tr>
<tr class="memdesc:aec5c1028fa3e25ad60e439fd64afb245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the size of the font used in the cell.  <a href="format_8h.html#aec5c1028fa3e25ad60e439fd64afb245">More...</a><br /></td></tr>
<tr class="separator:aec5c1028fa3e25ad60e439fd64afb245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61981b2080bfe6381ede5358ee05b05c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a61981b2080bfe6381ede5358ee05b05c">format_set_font_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:a61981b2080bfe6381ede5358ee05b05c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the color of the font used in the cell.  <a href="format_8h.html#a61981b2080bfe6381ede5358ee05b05c">More...</a><br /></td></tr>
<tr class="separator:a61981b2080bfe6381ede5358ee05b05c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85e1b0baf44b445b65894e48722aec14"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a85e1b0baf44b445b65894e48722aec14">format_set_bold</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format)</td></tr>
<tr class="memdesc:a85e1b0baf44b445b65894e48722aec14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Turn on bold for the format font.  <a href="format_8h.html#a85e1b0baf44b445b65894e48722aec14">More...</a><br /></td></tr>
<tr class="separator:a85e1b0baf44b445b65894e48722aec14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19cbd7c34692eb7fb35a7411432d836e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a19cbd7c34692eb7fb35a7411432d836e">format_set_italic</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format)</td></tr>
<tr class="memdesc:a19cbd7c34692eb7fb35a7411432d836e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Turn on italic for the format font.  <a href="format_8h.html#a19cbd7c34692eb7fb35a7411432d836e">More...</a><br /></td></tr>
<tr class="separator:a19cbd7c34692eb7fb35a7411432d836e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad35ee5445826bd93ec1bc0d489fc09db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#ad35ee5445826bd93ec1bc0d489fc09db">format_set_underline</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:ad35ee5445826bd93ec1bc0d489fc09db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Turn on underline for the format:  <a href="format_8h.html#ad35ee5445826bd93ec1bc0d489fc09db">More...</a><br /></td></tr>
<tr class="separator:ad35ee5445826bd93ec1bc0d489fc09db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6e9600723fd772c3cd4d62599beaf31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#ad6e9600723fd772c3cd4d62599beaf31">format_set_font_strikeout</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format)</td></tr>
<tr class="memdesc:ad6e9600723fd772c3cd4d62599beaf31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the strikeout property of the font.  <a href="format_8h.html#ad6e9600723fd772c3cd4d62599beaf31">More...</a><br /></td></tr>
<tr class="separator:ad6e9600723fd772c3cd4d62599beaf31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a471ca432e429505c79982ca5aecd1db0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a471ca432e429505c79982ca5aecd1db0">format_set_font_script</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:a471ca432e429505c79982ca5aecd1db0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the superscript/subscript property of the font.  <a href="format_8h.html#a471ca432e429505c79982ca5aecd1db0">More...</a><br /></td></tr>
<tr class="separator:a471ca432e429505c79982ca5aecd1db0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af77bbd0003344cb16d455c7fb709e16c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, const char *num_format)</td></tr>
<tr class="memdesc:af77bbd0003344cb16d455c7fb709e16c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the number format for a cell.  <a href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">More...</a><br /></td></tr>
<tr class="separator:af77bbd0003344cb16d455c7fb709e16c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a688aa42bcc703d17e125d9a34c721872"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a688aa42bcc703d17e125d9a34c721872">format_set_num_format_index</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t index)</td></tr>
<tr class="memdesc:a688aa42bcc703d17e125d9a34c721872"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Excel built-in number format for a cell.  <a href="format_8h.html#a688aa42bcc703d17e125d9a34c721872">More...</a><br /></td></tr>
<tr class="separator:a688aa42bcc703d17e125d9a34c721872"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dfd61b72aab2c28c3d51e53e08df587"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a1dfd61b72aab2c28c3d51e53e08df587">format_set_unlocked</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format)</td></tr>
<tr class="memdesc:a1dfd61b72aab2c28c3d51e53e08df587"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the cell unlocked state.  <a href="format_8h.html#a1dfd61b72aab2c28c3d51e53e08df587">More...</a><br /></td></tr>
<tr class="separator:a1dfd61b72aab2c28c3d51e53e08df587"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a135d94ec48564c997c5a78ca8b8861e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a135d94ec48564c997c5a78ca8b8861e2">format_set_hidden</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format)</td></tr>
<tr class="memdesc:a135d94ec48564c997c5a78ca8b8861e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hide formulas in a cell.  <a href="format_8h.html#a135d94ec48564c997c5a78ca8b8861e2">More...</a><br /></td></tr>
<tr class="separator:a135d94ec48564c997c5a78ca8b8861e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a189c83d1f21b01937f1f730720c33d13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a189c83d1f21b01937f1f730720c33d13">format_set_align</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t alignment)</td></tr>
<tr class="memdesc:a189c83d1f21b01937f1f730720c33d13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the alignment for data in the cell.  <a href="format_8h.html#a189c83d1f21b01937f1f730720c33d13">More...</a><br /></td></tr>
<tr class="separator:a189c83d1f21b01937f1f730720c33d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56d55dd9257d8f0645c62b296d2c196d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a56d55dd9257d8f0645c62b296d2c196d">format_set_text_wrap</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format)</td></tr>
<tr class="memdesc:a56d55dd9257d8f0645c62b296d2c196d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrap text in a cell.  <a href="format_8h.html#a56d55dd9257d8f0645c62b296d2c196d">More...</a><br /></td></tr>
<tr class="separator:a56d55dd9257d8f0645c62b296d2c196d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae690004cd77f48646da07796b540c309"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#ae690004cd77f48646da07796b540c309">format_set_rotation</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, int16_t angle)</td></tr>
<tr class="memdesc:ae690004cd77f48646da07796b540c309"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the rotation of the text in a cell.  <a href="format_8h.html#ae690004cd77f48646da07796b540c309">More...</a><br /></td></tr>
<tr class="separator:ae690004cd77f48646da07796b540c309"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99aea699cd7bb3c56a515c9c9e0caa69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a99aea699cd7bb3c56a515c9c9e0caa69">format_set_indent</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t level)</td></tr>
<tr class="memdesc:a99aea699cd7bb3c56a515c9c9e0caa69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the cell text indentation level.  <a href="format_8h.html#a99aea699cd7bb3c56a515c9c9e0caa69">More...</a><br /></td></tr>
<tr class="separator:a99aea699cd7bb3c56a515c9c9e0caa69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fc47dd0e47020358c79e20039cbd760"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a8fc47dd0e47020358c79e20039cbd760">format_set_shrink</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format)</td></tr>
<tr class="memdesc:a8fc47dd0e47020358c79e20039cbd760"><td class="mdescLeft">&#160;</td><td class="mdescRight">Turn on the text "shrink to fit" for a cell.  <a href="format_8h.html#a8fc47dd0e47020358c79e20039cbd760">More...</a><br /></td></tr>
<tr class="separator:a8fc47dd0e47020358c79e20039cbd760"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43ddbc77d637b04fdfbc45e96857d15a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a">format_set_pattern</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t index)</td></tr>
<tr class="memdesc:a43ddbc77d637b04fdfbc45e96857d15a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the background fill pattern for a cell.  <a href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a">More...</a><br /></td></tr>
<tr class="separator:a43ddbc77d637b04fdfbc45e96857d15a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeef47436c335daf1801683ac7b3b587d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#aeef47436c335daf1801683ac7b3b587d">format_set_bg_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:aeef47436c335daf1801683ac7b3b587d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the pattern background color for a cell.  <a href="format_8h.html#aeef47436c335daf1801683ac7b3b587d">More...</a><br /></td></tr>
<tr class="separator:aeef47436c335daf1801683ac7b3b587d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65086b2b6ee51fd34893e3c53e0578eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a65086b2b6ee51fd34893e3c53e0578eb">format_set_fg_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:a65086b2b6ee51fd34893e3c53e0578eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the pattern foreground color for a cell.  <a href="format_8h.html#a65086b2b6ee51fd34893e3c53e0578eb">More...</a><br /></td></tr>
<tr class="separator:a65086b2b6ee51fd34893e3c53e0578eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cf7a28a6e8014cb98dff27415e2b1ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca">format_set_border</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:a9cf7a28a6e8014cb98dff27415e2b1ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the cell border style.  <a href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca">More...</a><br /></td></tr>
<tr class="separator:a9cf7a28a6e8014cb98dff27415e2b1ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05edc61c138b3ba56727efa24592e990"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a05edc61c138b3ba56727efa24592e990">format_set_bottom</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:a05edc61c138b3ba56727efa24592e990"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the cell bottom border style.  <a href="format_8h.html#a05edc61c138b3ba56727efa24592e990">More...</a><br /></td></tr>
<tr class="separator:a05edc61c138b3ba56727efa24592e990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39589314f295cf5610a759d233d1e9c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a39589314f295cf5610a759d233d1e9c5">format_set_top</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:a39589314f295cf5610a759d233d1e9c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the cell top border style.  <a href="format_8h.html#a39589314f295cf5610a759d233d1e9c5">More...</a><br /></td></tr>
<tr class="separator:a39589314f295cf5610a759d233d1e9c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21f80d92069d1c0a422daa954c4c6eaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a21f80d92069d1c0a422daa954c4c6eaa">format_set_left</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:a21f80d92069d1c0a422daa954c4c6eaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the cell left border style.  <a href="format_8h.html#a21f80d92069d1c0a422daa954c4c6eaa">More...</a><br /></td></tr>
<tr class="separator:a21f80d92069d1c0a422daa954c4c6eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4deaaa289159778326c8eb901c70fbb9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a4deaaa289159778326c8eb901c70fbb9">format_set_right</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:a4deaaa289159778326c8eb901c70fbb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the cell right border style.  <a href="format_8h.html#a4deaaa289159778326c8eb901c70fbb9">More...</a><br /></td></tr>
<tr class="separator:a4deaaa289159778326c8eb901c70fbb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8fa6d2b638012fc6e331fcd5cf4266b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#ad8fa6d2b638012fc6e331fcd5cf4266b">format_set_border_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:ad8fa6d2b638012fc6e331fcd5cf4266b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the color of the cell border.  <a href="format_8h.html#ad8fa6d2b638012fc6e331fcd5cf4266b">More...</a><br /></td></tr>
<tr class="separator:ad8fa6d2b638012fc6e331fcd5cf4266b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53d5df0f55f154b1019e19f7db3f7df3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a53d5df0f55f154b1019e19f7db3f7df3">format_set_bottom_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:a53d5df0f55f154b1019e19f7db3f7df3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the color of the bottom cell border.  <a href="format_8h.html#a53d5df0f55f154b1019e19f7db3f7df3">More...</a><br /></td></tr>
<tr class="separator:a53d5df0f55f154b1019e19f7db3f7df3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1126cbf0f5d4a5832d251572566335e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#af1126cbf0f5d4a5832d251572566335e">format_set_top_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:af1126cbf0f5d4a5832d251572566335e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the color of the top cell border.  <a href="format_8h.html#af1126cbf0f5d4a5832d251572566335e">More...</a><br /></td></tr>
<tr class="separator:af1126cbf0f5d4a5832d251572566335e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72ae1cd4040cc5d8b6c7b10697fe982a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a72ae1cd4040cc5d8b6c7b10697fe982a">format_set_left_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:a72ae1cd4040cc5d8b6c7b10697fe982a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the color of the left cell border.  <a href="format_8h.html#a72ae1cd4040cc5d8b6c7b10697fe982a">More...</a><br /></td></tr>
<tr class="separator:a72ae1cd4040cc5d8b6c7b10697fe982a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b1965f2420d7803b6ad5d5b33ce73a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a8b1965f2420d7803b6ad5d5b33ce73a9">format_set_right_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:a8b1965f2420d7803b6ad5d5b33ce73a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the color of the right cell border.  <a href="format_8h.html#a8b1965f2420d7803b6ad5d5b33ce73a9">More...</a><br /></td></tr>
<tr class="separator:a8b1965f2420d7803b6ad5d5b33ce73a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bd8ade5206d187f4f790dbb004ca129"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a1bd8ade5206d187f4f790dbb004ca129">format_set_diag_type</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t type)</td></tr>
<tr class="memdesc:a1bd8ade5206d187f4f790dbb004ca129"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the diagonal cell border type.  <a href="format_8h.html#a1bd8ade5206d187f4f790dbb004ca129">More...</a><br /></td></tr>
<tr class="separator:a1bd8ade5206d187f4f790dbb004ca129"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60a053a40e1e70d5ad4a6171458a360a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a60a053a40e1e70d5ad4a6171458a360a">format_set_diag_border</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, uint8_t style)</td></tr>
<tr class="memdesc:a60a053a40e1e70d5ad4a6171458a360a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the diagonal cell border style.  <a href="format_8h.html#a60a053a40e1e70d5ad4a6171458a360a">More...</a><br /></td></tr>
<tr class="separator:a60a053a40e1e70d5ad4a6171458a360a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfffdfb19f1c5bf6ad95a1b40cec2d35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#abfffdfb19f1c5bf6ad95a1b40cec2d35">format_set_diag_color</a> (<a class="el" href="structlxw__format.html">lxw_format</a> *format, <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> color)</td></tr>
<tr class="memdesc:abfffdfb19f1c5bf6ad95a1b40cec2d35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the diagonal cell border color.  <a href="format_8h.html#abfffdfb19f1c5bf6ad95a1b40cec2d35">More...</a><br /></td></tr>
<tr class="separator:abfffdfb19f1c5bf6ad95a1b40cec2d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a449e2235a9088cc60233ae443acd2b1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a449e2235a9088cc60233ae443acd2b1a">&#9670;&nbsp;</a></span>format_set_font_name()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_font_name </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>font_name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">font_name</td><td>Cell font name.</td></tr>
  </table>
  </dd>
</dl>
<p>Specify the font used used in the cell format:</p>
<div class="fragment"><div class="line"><a class="code" href="format_8h.html#a449e2235a9088cc60233ae443acd2b1a">format_set_font_name</a>(format, <span class="stringliteral">&quot;Avenir Black Oblique&quot;</span>);</div>
</div><!-- fragment --><div class="image">
<img src="format_set_font_name.png" alt=""/>
</div>
<p>Excel can only display fonts that are installed on the system that it is running on. Therefore it is generally best to use the fonts that come as standard with Excel such as Calibri, Times New Roman and Courier New.</p>
<p>The default font in Excel 2007, and later, is Calibri. </p>

</div>
</div>
<a id="aec5c1028fa3e25ad60e439fd64afb245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec5c1028fa3e25ad60e439fd64afb245">&#9670;&nbsp;</a></span>format_set_font_size()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_font_size </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">size</td><td>The cell font size.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the font size of the cell format:</p>
<div class="fragment"><div class="line"><a class="code" href="format_8h.html#aec5c1028fa3e25ad60e439fd64afb245">format_set_font_size</a>(format, 30);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_size.png" alt=""/>
</div>
<p>Excel adjusts the height of a row to accommodate the largest font size in the row. You can also explicitly specify the height of a row using the <a class="el" href="worksheet_8h.html#ab9b7fb95e1bd9b0da70befd0d37a9173" title="Set the properties for a row of cells.">worksheet_set_row()</a> function. </p>

</div>
</div>
<a id="a61981b2080bfe6381ede5358ee05b05c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61981b2080bfe6381ede5358ee05b05c">&#9670;&nbsp;</a></span>format_set_font_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_font_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell font color.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the font color:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a61981b2080bfe6381ede5358ee05b05c">format_set_font_color</a>(format, <a class="code" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec">LXW_COLOR_RED</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Wheelbarrow&quot;</span>, format);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_color.png" alt=""/>
</div>
<p>The color should be an RGB integer value, see <a class="el" href="working_with_colors.html">Working with Colors</a>.</p>
<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="format_8h.html#a61981b2080bfe6381ede5358ee05b05c" title="Set the color of the font used in the cell.">format_set_font_color()</a> method is used to set the font color in a cell. To set the color of a cell background use the <a class="el" href="format_8h.html#aeef47436c335daf1801683ac7b3b587d" title="Set the pattern background color for a cell.">format_set_bg_color()</a> and <a class="el" href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a" title="Set the background fill pattern for a cell.">format_set_pattern()</a> methods. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="conditional_format1_8c-example.html#a8">conditional_format1.c</a>, <a class="el" href="conditional_format2_8c-example.html#a9">conditional_format2.c</a>, <a class="el" href="hyperlinks_8c-example.html#a9">hyperlinks.c</a>, <a class="el" href="merge_rich_string_8c-example.html#a11">merge_rich_string.c</a>, and <a class="el" href="rich_strings_8c-example.html#a8">rich_strings.c</a>.</dd>
</dl>

</div>
</div>
<a id="a85e1b0baf44b445b65894e48722aec14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85e1b0baf44b445b65894e48722aec14">&#9670;&nbsp;</a></span>format_set_bold()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_bold </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the bold property of the font:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a85e1b0baf44b445b65894e48722aec14">format_set_bold</a>(format);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Bold Text&quot;</span>, format);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_bold.png" alt=""/>
</div>
 <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="anatomy_8c-example.html#a6">anatomy.c</a>, <a class="el" href="chart_area_8c-example.html#a10">chart_area.c</a>, <a class="el" href="chart_bar_8c-example.html#a10">chart_bar.c</a>, <a class="el" href="chart_clustered_8c-example.html#a11">chart_clustered.c</a>, <a class="el" href="chart_column_8c-example.html#a10">chart_column.c</a>, <a class="el" href="chart_data_labels_8c-example.html#a6">chart_data_labels.c</a>, <a class="el" href="chart_data_table_8c-example.html#a10">chart_data_table.c</a>, <a class="el" href="chart_data_tools_8c-example.html#a10">chart_data_tools.c</a>, <a class="el" href="chart_doughnut_8c-example.html#a11">chart_doughnut.c</a>, <a class="el" href="chart_line_8c-example.html#a10">chart_line.c</a>, <a class="el" href="chart_pattern_8c-example.html#a7">chart_pattern.c</a>, <a class="el" href="chart_pie_8c-example.html#a11">chart_pie.c</a>, <a class="el" href="chart_radar_8c-example.html#a10">chart_radar.c</a>, <a class="el" href="chart_scatter_8c-example.html#a10">chart_scatter.c</a>, <a class="el" href="chartsheet_8c-example.html#a12">chartsheet.c</a>, <a class="el" href="data_validate_8c-example.html#a14">data_validate.c</a>, <a class="el" href="dates_and_times03_8c-example.html#a7">dates_and_times03.c</a>, <a class="el" href="demo_8c-example.html#a6">demo.c</a>, <a class="el" href="format_font_8c-example.html#a7">format_font.c</a>, <a class="el" href="merge_range_8c-example.html#a9">merge_range.c</a>, <a class="el" href="outline_8c-example.html#a6">outline.c</a>, <a class="el" href="outline_collapsed_8c-example.html#a12">outline_collapsed.c</a>, <a class="el" href="panes_8c-example.html#a10">panes.c</a>, <a class="el" href="rich_strings_8c-example.html#a6">rich_strings.c</a>, <a class="el" href="tutorial2_8c-example.html#a6">tutorial2.c</a>, and <a class="el" href="tutorial3_8c-example.html#a8">tutorial3.c</a>.</dd>
</dl>

</div>
</div>
<a id="a19cbd7c34692eb7fb35a7411432d836e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19cbd7c34692eb7fb35a7411432d836e">&#9670;&nbsp;</a></span>format_set_italic()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_italic </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the italic property of the font:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a19cbd7c34692eb7fb35a7411432d836e">format_set_italic</a>(format);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Italic Text&quot;</span>, format);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_italic.png" alt=""/>
</div>
 <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="format_font_8c-example.html#a8">format_font.c</a>, and <a class="el" href="rich_strings_8c-example.html#a7">rich_strings.c</a>.</dd>
</dl>

</div>
</div>
<a id="ad35ee5445826bd93ec1bc0d489fc09db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad35ee5445826bd93ec1bc0d489fc09db">&#9670;&nbsp;</a></span>format_set_underline()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_underline </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>Underline style.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the underline property of the format:</p>
<div class="fragment"><div class="line"><a class="code" href="format_8h.html#ad35ee5445826bd93ec1bc0d489fc09db">format_set_underline</a>(format, <a class="code" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa76d5bdd1c57c126df937f0b003597e18">LXW_UNDERLINE_SINGLE</a>);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_underlined.png" alt=""/>
</div>
<p>The available underline styles are:</p>
<ul>
<li><a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa76d5bdd1c57c126df937f0b003597e18">LXW_UNDERLINE_SINGLE</a></li>
<li><a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa578bcd2c45f3d549fcfc46937550de13">LXW_UNDERLINE_DOUBLE</a></li>
<li><a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39faac874d8fee3376d3e989ca008001f6ed">LXW_UNDERLINE_SINGLE_ACCOUNTING</a></li>
<li><a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa63088febe121487e7269d6aedcafa628">LXW_UNDERLINE_DOUBLE_ACCOUNTING</a> </li>
</ul>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="hyperlinks_8c-example.html#a7">hyperlinks.c</a>.</dd>
</dl>

</div>
</div>
<a id="ad6e9600723fd772c3cd4d62599beaf31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6e9600723fd772c3cd4d62599beaf31">&#9670;&nbsp;</a></span>format_set_font_strikeout()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_font_strikeout </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance.</td></tr>
  </table>
  </dd>
</dl>
<div class="image">
<img src="format_font_strikeout.png" alt=""/>
</div>
 
</div>
</div>
<a id="a471ca432e429505c79982ca5aecd1db0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a471ca432e429505c79982ca5aecd1db0">&#9670;&nbsp;</a></span>format_set_font_script()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_font_script </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>Superscript or subscript style.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the superscript o subscript property of the font.</p>
<div class="image">
<img src="format_font_script.png" alt=""/>
</div>
<p>The available script styles are:</p>
<ul>
<li><a class="el" href="format_8h.html#a0ff8fd761893f60fddbd7f1cab4ac75aa191621e73f0f2837147d221ed5f06034">LXW_FONT_SUPERSCRIPT</a></li>
<li><a class="el" href="format_8h.html#a0ff8fd761893f60fddbd7f1cab4ac75aa38cf7f98c69b63c30194c5907f8397ec">LXW_FONT_SUBSCRIPT</a> </li>
</ul>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="rich_strings_8c-example.html#a13">rich_strings.c</a>.</dd>
</dl>

</div>
</div>
<a id="af77bbd0003344cb16d455c7fb709e16c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af77bbd0003344cb16d455c7fb709e16c">&#9670;&nbsp;</a></span>format_set_num_format()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_num_format </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>num_format</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">num_format</td><td>The cell number format string.</td></tr>
  </table>
  </dd>
</dl>
<p>This method is used to define the numerical format of a number in Excel. It controls whether a number is displayed as an integer, a floating point number, a date, a currency value or some other user defined format.</p>
<p>The numerical format of a cell can be specified by using a format string:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format, <span class="stringliteral">&quot;d mmm yyyy&quot;</span>);</div>
</div><!-- fragment --><p>Format strings can control any aspect of number formatting allowed by Excel:</p>
 <div class="fragment"><div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format01, <span class="stringliteral">&quot;0.000&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format02, <span class="stringliteral">&quot;#,##0&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format03, <span class="stringliteral">&quot;#,##0.00&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format04, <span class="stringliteral">&quot;0.00&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format05, <span class="stringliteral">&quot;mm/dd/yy&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format06, <span class="stringliteral">&quot;mmm d yyyy&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format07, <span class="stringliteral">&quot;d mmmm yyyy&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format08, <span class="stringliteral">&quot;dd/mm/yyyy hh:mm AM/PM&quot;</span>);</div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format09, <span class="stringliteral">&quot;0 \&quot;dollar and\&quot; .00 \&quot;cents\&quot;&quot;</span>);</div>
<div class="line"> </div>
<div class="line">    <span class="comment">/* Write data using the formats. */</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 0, 0, 3.1415926, NULL);      <span class="comment">// 3.1415926</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 1, 0, 3.1415926, format01);  <span class="comment">// 3.142</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 2, 0, 1234.56,   format02);  <span class="comment">// 1,235</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 3, 0, 1234.56,   format03);  <span class="comment">// 1,234.56</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 4, 0, 49.99,     format04);  <span class="comment">// 49.99</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 5, 0, 36892.521, format05);  <span class="comment">// 01/01/01</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 6, 0, 36892.521, format06);  <span class="comment">// Jan 1 2001</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 7, 0, 36892.521, format07);  <span class="comment">// 1 January 2001</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 8, 0, 36892.521, format08);  <span class="comment">// 01/01/2001 12:30 AM</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 9, 0, 1.87,      format09);  <span class="comment">// 1 dollar and .87 cents</span></div>
<div class="line"> </div>
<div class="line">    <span class="comment">/* Show limited conditional number formats. */</span></div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format10, <span class="stringliteral">&quot;[Green]General;[Red]-General;General&quot;</span>);</div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 10, 0, 123, format10);  <span class="comment">// &gt; 0 Green</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 11, 0, -45, format10);  <span class="comment">// &lt; 0 Red</span></div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 12, 0,   0, format10);  <span class="comment">// = 0 Default color</span></div>
<div class="line"> </div>
<div class="line">    <span class="comment">/* Format a Zip code. */</span></div>
<div class="line">    <a class="code" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a>(format11, <span class="stringliteral">&quot;00000&quot;</span>);</div>
<div class="line">    <a class="code" href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a>(worksheet, 13, 0, 1209, format11);</div>
</div><!-- fragment --><div class="image">
<img src="format_set_num_format.png" alt=""/>
</div>
<p>To set a number format that matches an Excel format category such as "Date" or "Currency" see <a class="el" href="working_with_formats.html#ww_formats_categories">Number Format Categories</a>.</p>
<p>The number system used for dates is described in <a class="el" href="working_with_dates.html">Working with Dates and Times</a>.</p>
<p>For more information on number formats in Excel refer to the <a href="http://office.microsoft.com/en-gb/assistance/HP051995001033.aspx">Microsoft documentation on cell formats</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="anatomy_8c-example.html#a7">anatomy.c</a>, <a class="el" href="dates_and_times01_8c-example.html#a6">dates_and_times01.c</a>, <a class="el" href="dates_and_times02_8c-example.html#a7">dates_and_times02.c</a>, <a class="el" href="dates_and_times03_8c-example.html#a10">dates_and_times03.c</a>, <a class="el" href="format_num_format_8c-example.html#a7">format_num_format.c</a>, <a class="el" href="tutorial2_8c-example.html#a7">tutorial2.c</a>, and <a class="el" href="tutorial3_8c-example.html#a9">tutorial3.c</a>.</dd>
</dl>

</div>
</div>
<a id="a688aa42bcc703d17e125d9a34c721872"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a688aa42bcc703d17e125d9a34c721872">&#9670;&nbsp;</a></span>format_set_num_format_index()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_num_format_index </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">index</td><td>The built-in number format index for the cell.</td></tr>
  </table>
  </dd>
</dl>
<p>This function is similar to <a class="el" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c" title="Set the number format for a cell.">format_set_num_format()</a> except that it takes an index to a limited number of Excel's built-in number formats instead of a user defined format string:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a688aa42bcc703d17e125d9a34c721872">format_set_num_format_index</a>(format, 0x0F); <span class="comment">// d-mmm-yy</span></div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>Unless you need to specifically access one of Excel's built-in number formats the <a class="el" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c" title="Set the number format for a cell.">format_set_num_format()</a> function above is a better solution. The <a class="el" href="format_8h.html#a688aa42bcc703d17e125d9a34c721872" title="Set the Excel built-in number format for a cell.">format_set_num_format_index()</a> function is mainly included for backward compatibility and completeness.</dd></dl>
<p>The Excel built-in number formats as shown in the table below:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Index  </th><th class="markdownTableHeadNone">Index  </th><th class="markdownTableHeadNone">Format String   </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">0  </td><td class="markdownTableBodyNone">0x00  </td><td class="markdownTableBodyNone"><code>General</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">1  </td><td class="markdownTableBodyNone">0x01  </td><td class="markdownTableBodyNone"><code>0</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">2  </td><td class="markdownTableBodyNone">0x02  </td><td class="markdownTableBodyNone"><code>0.00</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">3  </td><td class="markdownTableBodyNone">0x03  </td><td class="markdownTableBodyNone"><code>#,##0</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">4  </td><td class="markdownTableBodyNone">0x04  </td><td class="markdownTableBodyNone"><code>#,##0.00</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">5  </td><td class="markdownTableBodyNone">0x05  </td><td class="markdownTableBodyNone"><code>($#,##0_);($#,##0)</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">6  </td><td class="markdownTableBodyNone">0x06  </td><td class="markdownTableBodyNone"><code>($#,##0_);[Red]($#,##0)</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">7  </td><td class="markdownTableBodyNone">0x07  </td><td class="markdownTableBodyNone"><code>($#,##0.00_);($#,##0.00)</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">8  </td><td class="markdownTableBodyNone">0x08  </td><td class="markdownTableBodyNone"><code>($#,##0.00_);[Red]($#,##0.00)</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">9  </td><td class="markdownTableBodyNone">0x09  </td><td class="markdownTableBodyNone"><code>0%</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">10  </td><td class="markdownTableBodyNone">0x0a  </td><td class="markdownTableBodyNone"><code>0.00%</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">11  </td><td class="markdownTableBodyNone">0x0b  </td><td class="markdownTableBodyNone"><code>0.00E+00</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">12  </td><td class="markdownTableBodyNone">0x0c  </td><td class="markdownTableBodyNone"><code># ?/?</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">13  </td><td class="markdownTableBodyNone">0x0d  </td><td class="markdownTableBodyNone"><code># ??/??</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">14  </td><td class="markdownTableBodyNone">0x0e  </td><td class="markdownTableBodyNone"><code>m/d/yy</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">15  </td><td class="markdownTableBodyNone">0x0f  </td><td class="markdownTableBodyNone"><code>d-mmm-yy</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">16  </td><td class="markdownTableBodyNone">0x10  </td><td class="markdownTableBodyNone"><code>d-mmm</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">17  </td><td class="markdownTableBodyNone">0x11  </td><td class="markdownTableBodyNone"><code>mmm-yy</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">18  </td><td class="markdownTableBodyNone">0x12  </td><td class="markdownTableBodyNone"><code>h:mm AM/PM</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">19  </td><td class="markdownTableBodyNone">0x13  </td><td class="markdownTableBodyNone"><code>h:mm:ss AM/PM</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">20  </td><td class="markdownTableBodyNone">0x14  </td><td class="markdownTableBodyNone"><code>h:mm</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">21  </td><td class="markdownTableBodyNone">0x15  </td><td class="markdownTableBodyNone"><code>h:mm:ss</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">22  </td><td class="markdownTableBodyNone">0x16  </td><td class="markdownTableBodyNone"><code>m/d/yy h:mm</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">...  </td><td class="markdownTableBodyNone">...  </td><td class="markdownTableBodyNone">...   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">37  </td><td class="markdownTableBodyNone">0x25  </td><td class="markdownTableBodyNone"><code>(#,##0_);(#,##0)</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">38  </td><td class="markdownTableBodyNone">0x26  </td><td class="markdownTableBodyNone"><code>(#,##0_);[Red](#,##0)</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">39  </td><td class="markdownTableBodyNone">0x27  </td><td class="markdownTableBodyNone"><code>(#,##0.00_);(#,##0.00)</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">40  </td><td class="markdownTableBodyNone">0x28  </td><td class="markdownTableBodyNone"><code>(#,##0.00_);[Red](#,##0.00)</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">41  </td><td class="markdownTableBodyNone">0x29  </td><td class="markdownTableBodyNone"><code>_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">42  </td><td class="markdownTableBodyNone">0x2a  </td><td class="markdownTableBodyNone"><code>_($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">43  </td><td class="markdownTableBodyNone">0x2b  </td><td class="markdownTableBodyNone"><code>_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">44  </td><td class="markdownTableBodyNone">0x2c  </td><td class="markdownTableBodyNone"><code>_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">45  </td><td class="markdownTableBodyNone">0x2d  </td><td class="markdownTableBodyNone"><code>mm:ss</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">46  </td><td class="markdownTableBodyNone">0x2e  </td><td class="markdownTableBodyNone"><code>[h]:mm:ss</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">47  </td><td class="markdownTableBodyNone">0x2f  </td><td class="markdownTableBodyNone"><code>mm:ss.0</code>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">48  </td><td class="markdownTableBodyNone">0x30  </td><td class="markdownTableBodyNone"><code>##0.0E+0</code>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">49  </td><td class="markdownTableBodyNone">0x31  </td><td class="markdownTableBodyNone"><code>@</code>   </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>Numeric formats 23 to 36 are not documented by Microsoft and may differ in international versions. The listed date and currency formats may also vary depending on system settings.</li>
<li>The dollar sign in the above format appears as the defined local currency symbol.</li>
<li>These formats can also be set via <a class="el" href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c" title="Set the number format for a cell.">format_set_num_format()</a>.</li>
<li>See also <a class="el" href="working_with_formats.html#ww_formats_categories">Number Format Categories</a>. </li>
</ul>
</dd></dl>

</div>
</div>
<a id="a1dfd61b72aab2c28c3d51e53e08df587"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dfd61b72aab2c28c3d51e53e08df587">&#9670;&nbsp;</a></span>format_set_unlocked()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_unlocked </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance.</td></tr>
  </table>
  </dd>
</dl>
<p>This property can be used to allow modification of a cell in a protected worksheet. In Excel, cell locking is turned on by default for all cells. However, it only has an effect if the worksheet has been protected using the worksheet <a class="el" href="worksheet_8h.html#a1b49e135d4debcdb25941f2f40f04cb0" title="Protect elements of a worksheet from modification.">worksheet_protect()</a> function:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a1dfd61b72aab2c28c3d51e53e08df587">format_set_unlocked</a>(format);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Enable worksheet protection, without password or options.</span></div>
<div class="line"><a class="code" href="worksheet_8h.html#a1b49e135d4debcdb25941f2f40f04cb0">worksheet_protect</a>(worksheet, NULL, NULL);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// This cell cannot be edited.</span></div>
<div class="line"><a class="code" href="worksheet_8h.html#ae57117f04c82bef29805ec3eabc219bb">worksheet_write_formula</a>(worksheet, 0, 0, <span class="stringliteral">&quot;=1+2&quot;</span>, NULL);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// This cell can be edited.</span></div>
<div class="line"><a class="code" href="worksheet_8h.html#ae57117f04c82bef29805ec3eabc219bb">worksheet_write_formula</a>(worksheet, 1, 0, <span class="stringliteral">&quot;=1+2&quot;</span>, format);</div>
</div><!-- fragment --> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="worksheet_protection_8c-example.html#a6">worksheet_protection.c</a>.</dd>
</dl>

</div>
</div>
<a id="a135d94ec48564c997c5a78ca8b8861e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a135d94ec48564c997c5a78ca8b8861e2">&#9670;&nbsp;</a></span>format_set_hidden()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_hidden </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance.</td></tr>
  </table>
  </dd>
</dl>
<p>This property is used to hide a formula while still displaying its result. This is generally used to hide complex calculations from end users who are only interested in the result. It only has an effect if the worksheet has been protected using the worksheet <a class="el" href="worksheet_8h.html#a1b49e135d4debcdb25941f2f40f04cb0" title="Protect elements of a worksheet from modification.">worksheet_protect()</a> function:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a135d94ec48564c997c5a78ca8b8861e2">format_set_hidden</a>(format);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Enable worksheet protection, without password or options.</span></div>
<div class="line"><a class="code" href="worksheet_8h.html#a1b49e135d4debcdb25941f2f40f04cb0">worksheet_protect</a>(worksheet, NULL, NULL);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// The formula in this cell isn&#39;t visible.</span></div>
<div class="line"><a class="code" href="worksheet_8h.html#ae57117f04c82bef29805ec3eabc219bb">worksheet_write_formula</a>(worksheet, 0, 0, <span class="stringliteral">&quot;=1+2&quot;</span>, format);</div>
</div><!-- fragment --> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="worksheet_protection_8c-example.html#a7">worksheet_protection.c</a>.</dd>
</dl>

</div>
</div>
<a id="a189c83d1f21b01937f1f730720c33d13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a189c83d1f21b01937f1f730720c33d13">&#9670;&nbsp;</a></span>format_set_align()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_align </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>alignment</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">alignment</td><td>The horizontal and or vertical alignment direction.</td></tr>
  </table>
  </dd>
</dl>
<p>This method is used to set the horizontal and vertical text alignment within a cell. The following are the available horizontal alignments:</p>
<ul>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a6d528fd0486c22c04941cd8ed1bbc8e1">LXW_ALIGN_LEFT</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a9899936ef3a43721b394b9b5d2314496">LXW_ALIGN_CENTER</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5acae72c15765797c03572554f57c82aa9">LXW_ALIGN_RIGHT</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5acfd1c600aa60d19d25b1026e7fa7fe1e">LXW_ALIGN_FILL</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a20ed1a57601ce09f6885fef25e63a660">LXW_ALIGN_JUSTIFY</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae1400bbf14fd49d4e3525f479a5f55f0">LXW_ALIGN_CENTER_ACROSS</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a1ff90b4c61e058bf2254f43e534d9c57">LXW_ALIGN_DISTRIBUTED</a></li>
</ul>
<p>The following are the available vertical alignments:</p>
<ul>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a9c365c63356bb50e4d6db97f59526b17">LXW_ALIGN_VERTICAL_TOP</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ab7dd1a8e22e59928d6258a7d3d44b0c7">LXW_ALIGN_VERTICAL_BOTTOM</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae0a52569d3110521d3e9341809336063">LXW_ALIGN_VERTICAL_CENTER</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a4940e5aa8e07a9d659d1cf6c2785286f">LXW_ALIGN_VERTICAL_JUSTIFY</a></li>
<li><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae456bcbbc14b0c142b808c49950ff710">LXW_ALIGN_VERTICAL_DISTRIBUTED</a></li>
</ul>
<p>As in Excel, vertical and horizontal alignments can be combined:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="format_8h.html#a189c83d1f21b01937f1f730720c33d13">format_set_align</a>(format, <a class="code" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a9899936ef3a43721b394b9b5d2314496">LXW_ALIGN_CENTER</a>);</div>
<div class="line"><a class="code" href="format_8h.html#a189c83d1f21b01937f1f730720c33d13">format_set_align</a>(format, <a class="code" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae0a52569d3110521d3e9341809336063">LXW_ALIGN_VERTICAL_CENTER</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ab9b7fb95e1bd9b0da70befd0d37a9173">worksheet_set_row</a>(0, 30);</div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Some Text&quot;</span>, format);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_align.png" alt=""/>
</div>
<p>Text can be aligned across two or more adjacent cells using the center_across property. However, for genuine merged cells it is better to use the <a class="el" href="worksheet_8h.html#ad5a2a09ec65c0f286b756235c7327225" title="Merge a range of cells.">worksheet_merge_range()</a> worksheet method.</p>
<p>The vertical justify option can be used to provide automatic text wrapping in a cell. The height of the cell will be adjusted to accommodate the wrapped text. To specify where the text wraps use the <a class="el" href="format_8h.html#a56d55dd9257d8f0645c62b296d2c196d" title="Wrap text in a cell.">format_set_text_wrap()</a> method. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a7">comments2.c</a>, <a class="el" href="data_validate_8c-example.html#a16">data_validate.c</a>, <a class="el" href="dates_and_times03_8c-example.html#a11">dates_and_times03.c</a>, <a class="el" href="merge_range_8c-example.html#a6">merge_range.c</a>, <a class="el" href="merge_rich_string_8c-example.html#a6">merge_rich_string.c</a>, <a class="el" href="panes_8c-example.html#a6">panes.c</a>, and <a class="el" href="rich_strings_8c-example.html#a11">rich_strings.c</a>.</dd>
</dl>

</div>
</div>
<a id="a56d55dd9257d8f0645c62b296d2c196d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56d55dd9257d8f0645c62b296d2c196d">&#9670;&nbsp;</a></span>format_set_text_wrap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_text_wrap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Turn text wrapping on for text in a cell.</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a56d55dd9257d8f0645c62b296d2c196d">format_set_text_wrap</a>(format);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Some long text to wrap in a cell&quot;</span>, format);</div>
</div><!-- fragment --><p>If you wish to control where the text is wrapped you can add newline characters to the string:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a56d55dd9257d8f0645c62b296d2c196d">format_set_text_wrap</a>(format);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;It&#39;s\na bum\nwrap&quot;</span>, format);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_text_wrap.png" alt=""/>
</div>
<p>Excel will adjust the height of the row to accommodate the wrapped text. A similar effect can be obtained without newlines using the <a class="el" href="format_8h.html#a189c83d1f21b01937f1f730720c33d13" title="Set the alignment for data in the cell.">format_set_align()</a> function with <a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a4940e5aa8e07a9d659d1cf6c2785286f">LXW_ALIGN_VERTICAL_JUSTIFY</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a6">comments2.c</a>, and <a class="el" href="data_validate_8c-example.html#a15">data_validate.c</a>.</dd>
</dl>

</div>
</div>
<a id="ae690004cd77f48646da07796b540c309"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae690004cd77f48646da07796b540c309">&#9670;&nbsp;</a></span>format_set_rotation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_rotation </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int16_t&#160;</td>
          <td class="paramname"><em>angle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">angle</td><td>Rotation angle in the range -90 to 90 and 270.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the rotation of the text in a cell. The rotation can be any angle in the range -90 to 90 degrees:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#ae690004cd77f48646da07796b540c309">format_set_rotation</a>(format, 30);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;This text is rotated&quot;</span>, format);</div>
</div><!-- fragment --><div class="image">
<img src="format_font_text_rotated.png" alt=""/>
</div>
<p>The angle 270 is also supported. This indicates text where the letters run from top to bottom. </p>

</div>
</div>
<a id="a99aea699cd7bb3c56a515c9c9e0caa69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99aea699cd7bb3c56a515c9c9e0caa69">&#9670;&nbsp;</a></span>format_set_indent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_indent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>level</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">level</td><td>Indentation level.</td></tr>
  </table>
  </dd>
</dl>
<p>This method can be used to indent text in a cell. The argument, which should be an integer, is taken as the level of indentation:</p>
<div class="fragment"><div class="line">format1 = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line">format2 = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="format_8h.html#a99aea699cd7bb3c56a515c9c9e0caa69">format_set_indent</a>(format1, 1);</div>
<div class="line"><a class="code" href="format_8h.html#a99aea699cd7bb3c56a515c9c9e0caa69">format_set_indent</a>(format2, 2);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;This text is indented 1 level&quot;</span>,  format1);</div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 1, 0, <span class="stringliteral">&quot;This text is indented 2 levels&quot;</span>, format2);</div>
</div><!-- fragment --><div class="image">
<img src="text_indent.png" alt=""/>
</div>
<dl class="section note"><dt>Note</dt><dd>Indentation is a horizontal alignment property. It will override any other horizontal properties but it can be used in conjunction with vertical properties. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="data_validate_8c-example.html#a18">data_validate.c</a>.</dd>
</dl>

</div>
</div>
<a id="a8fc47dd0e47020358c79e20039cbd760"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fc47dd0e47020358c79e20039cbd760">&#9670;&nbsp;</a></span>format_set_shrink()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_shrink </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance.</td></tr>
  </table>
  </dd>
</dl>
<p>This method can be used to shrink text so that it fits in a cell:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a8fc47dd0e47020358c79e20039cbd760">format_set_shrink</a>(format);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Honey, I shrunk the text!&quot;</span>, format);</div>
</div><!-- fragment --> 
</div>
</div>
<a id="a43ddbc77d637b04fdfbc45e96857d15a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43ddbc77d637b04fdfbc45e96857d15a">&#9670;&nbsp;</a></span>format_set_pattern()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_pattern </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">index</td><td>Pattern index.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the background pattern for a cell.</p>
<p>The most common pattern is a solid fill of the background color:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a">format_set_pattern</a> (format, <a class="code" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a1fbd6761c4ccd57d98dfd59eaad9fde5">LXW_PATTERN_SOLID</a>);</div>
<div class="line"><a class="code" href="format_8h.html#aeef47436c335daf1801683ac7b3b587d">format_set_bg_color</a>(format, <a class="code" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baebda4f169497f225a9c67bb51691c095">LXW_COLOR_YELLOW</a>);</div>
</div><!-- fragment --><p>The available fill patterns are:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Fill Type  </th><th class="markdownTableHeadNone">Define   </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Solid  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a1fbd6761c4ccd57d98dfd59eaad9fde5">LXW_PATTERN_SOLID</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Medium gray  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7af2abac6c05ed8772c2a21d95bce0c332">LXW_PATTERN_MEDIUM_GRAY</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Dark gray  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a7d852861b5d7206be22b15d9fccb024e">LXW_PATTERN_DARK_GRAY</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Light gray  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a9de2f62c80744dbe9d0f30328d5e8abd">LXW_PATTERN_LIGHT_GRAY</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Dark horizontal line  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a7cc5d51af6a1e10fddba733b9e4bd732">LXW_PATTERN_DARK_HORIZONTAL</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Dark vertical line  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a955a27466845e6c68c097e78cd9772ae">LXW_PATTERN_DARK_VERTICAL</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Dark diagonal stripe  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a704f3f128794e0bedec3635862e25211">LXW_PATTERN_DARK_DOWN</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Reverse dark diagonal stripe  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a107513419af030ee56d05ae6b5dbb528">LXW_PATTERN_DARK_UP</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Dark grid  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a44857e548d3a18290dac9e71addc6291">LXW_PATTERN_DARK_GRID</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Dark trellis  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a2fd1863ff664b2df2bbba4361c92fdca">LXW_PATTERN_DARK_TRELLIS</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Light horizontal line  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a324406f6c68917ffae078e8e329d182a">LXW_PATTERN_LIGHT_HORIZONTAL</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Light vertical line  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a2c064fc89708395070cebadaaa78b55d">LXW_PATTERN_LIGHT_VERTICAL</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Light diagonal stripe  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7ab17dcd0ae9f99188f60e36c26fbc1d83">LXW_PATTERN_LIGHT_DOWN</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Reverse light diagonal stripe  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7ab81adfee485941ecba5c0dd93f643592">LXW_PATTERN_LIGHT_UP</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Light grid  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a9e16acce0752307d5e05f76740883b11">LXW_PATTERN_LIGHT_GRID</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Light trellis  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a4b8228b008c86da617c35e34ec6abd11">LXW_PATTERN_LIGHT_TRELLIS</a>   </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">12.5% gray  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7ac2f4e6b63f812c6a93ec2dfa9ff26498">LXW_PATTERN_GRAY_125</a>   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">6.25% gray  </td><td class="markdownTableBodyNone"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a2d6d7aa016cb7468e5207a20eefb3f4f">LXW_PATTERN_GRAY_0625</a>   </td></tr>
</table>

</div>
</div>
<a id="aeef47436c335daf1801683ac7b3b587d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeef47436c335daf1801683ac7b3b587d">&#9670;&nbsp;</a></span>format_set_bg_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_bg_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell pattern background color.</td></tr>
  </table>
  </dd>
</dl>
<p>The <a class="el" href="format_8h.html#aeef47436c335daf1801683ac7b3b587d" title="Set the pattern background color for a cell.">format_set_bg_color()</a> method can be used to set the background color of a pattern. Patterns are defined via the <a class="el" href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a" title="Set the background fill pattern for a cell.">format_set_pattern()</a> method. If a pattern hasn't been defined then a solid fill pattern is used as the default.</p>
<p>Here is an example of how to set up a solid fill in a cell:</p>
<div class="fragment"><div class="line">format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a">format_set_pattern</a> (format, <a class="code" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a1fbd6761c4ccd57d98dfd59eaad9fde5">LXW_PATTERN_SOLID</a>);</div>
<div class="line"><a class="code" href="format_8h.html#aeef47436c335daf1801683ac7b3b587d">format_set_bg_color</a>(format, <a class="code" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871">LXW_COLOR_GREEN</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Ray&quot;</span>, format);</div>
</div><!-- fragment --><div class="image">
<img src="formats_set_bg_color.png" alt=""/>
</div>
<p>The color should be an RGB integer value, see <a class="el" href="working_with_colors.html">Working with Colors</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="conditional_format2_8c-example.html#a8">conditional_format2.c</a>, and <a class="el" href="merge_range_8c-example.html#a10">merge_range.c</a>.</dd>
</dl>

</div>
</div>
<a id="a65086b2b6ee51fd34893e3c53e0578eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65086b2b6ee51fd34893e3c53e0578eb">&#9670;&nbsp;</a></span>format_set_fg_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_fg_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell pattern foreground color.</td></tr>
  </table>
  </dd>
</dl>
<p>The <a class="el" href="format_8h.html#a65086b2b6ee51fd34893e3c53e0578eb" title="Set the pattern foreground color for a cell.">format_set_fg_color()</a> method can be used to set the foreground color of a pattern.</p>
<p>The color should be an RGB integer value, see <a class="el" href="working_with_colors.html">Working with Colors</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="data_validate_8c-example.html#a13">data_validate.c</a>, and <a class="el" href="panes_8c-example.html#a9">panes.c</a>.</dd>
</dl>

</div>
</div>
<a id="a9cf7a28a6e8014cb98dff27415e2b1ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cf7a28a6e8014cb98dff27415e2b1ca">&#9670;&nbsp;</a></span>format_set_border()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_border </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>Border style index.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the cell border style:</p>
<div class="fragment"><div class="line"><a class="code" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca">format_set_border</a>(format, <a class="code" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa7ca212fb42e5816bb81d7b96ff623082">LXW_BORDER_THIN</a>);</div>
</div><!-- fragment --><p>Individual border elements can be configured using the following functions with the same parameters:</p>
<ul>
<li><a class="el" href="format_8h.html#a05edc61c138b3ba56727efa24592e990" title="Set the cell bottom border style.">format_set_bottom()</a></li>
<li><a class="el" href="format_8h.html#a39589314f295cf5610a759d233d1e9c5" title="Set the cell top border style.">format_set_top()</a></li>
<li><a class="el" href="format_8h.html#a21f80d92069d1c0a422daa954c4c6eaa" title="Set the cell left border style.">format_set_left()</a></li>
<li><a class="el" href="format_8h.html#a4deaaa289159778326c8eb901c70fbb9" title="Set the cell right border style.">format_set_right()</a></li>
</ul>
<p>A cell border is comprised of a border on the bottom, top, left and right. These can be set to the same value using <a class="el" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca" title="Set the cell border style.">format_set_border()</a> or individually using the relevant method calls shown above.</p>
<p>The following border styles are available:</p>
<ul>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa7ca212fb42e5816bb81d7b96ff623082">LXW_BORDER_THIN</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8faf13965852c4b271b6cc58b74a0888ca1">LXW_BORDER_MEDIUM</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa27dd64afac6a3adf97afbb2f467f70c7">LXW_BORDER_DASHED</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa497a0e380b7b4b271291ccf45bd15cd8">LXW_BORDER_DOTTED</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fac837bde417fcfd8ff116ed1f188f4093">LXW_BORDER_THICK</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fafee0fd8f4ad9a64420efae0004448911">LXW_BORDER_DOUBLE</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fae7797837ba422a1906eae45fc70c433b">LXW_BORDER_HAIR</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa43e260c910dd9701593c9d208a4d8e43">LXW_BORDER_MEDIUM_DASHED</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fad6da2db66cdef3442012a64bd47084e5">LXW_BORDER_DASH_DOT</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa1227f361693ea996e1812d00e335e5c9">LXW_BORDER_MEDIUM_DASH_DOT</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa89c80e0b6bc3c632aefcb71fa25ccc31">LXW_BORDER_DASH_DOT_DOT</a></li>
<li><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8faf3b32f72854987702eed3b28d59d6eb6">LXW_BORDER_MEDIUM_DASH_DOT_DOT</a></li>
<li><p class="startli"><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fad6eb5faf3a43fc6d9546c433afd3a903">LXW_BORDER_SLANT_DASH_DOT</a></p>
<p class="startli">The most commonly used style is the <code>thin</code> style. </p>
</li>
</ul>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="data_validate_8c-example.html#a11">data_validate.c</a>, <a class="el" href="merge_range_8c-example.html#a12">merge_range.c</a>, <a class="el" href="merge_rich_string_8c-example.html#a9">merge_rich_string.c</a>, and <a class="el" href="panes_8c-example.html#a11">panes.c</a>.</dd>
</dl>

</div>
</div>
<a id="a05edc61c138b3ba56727efa24592e990"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05edc61c138b3ba56727efa24592e990">&#9670;&nbsp;</a></span>format_set_bottom()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_bottom </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>Border style index.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the cell bottom border style. See <a class="el" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca" title="Set the cell border style.">format_set_border()</a> for details on the border styles. </p>

</div>
</div>
<a id="a39589314f295cf5610a759d233d1e9c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39589314f295cf5610a759d233d1e9c5">&#9670;&nbsp;</a></span>format_set_top()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_top </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>Border style index.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the cell top border style. See <a class="el" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca" title="Set the cell border style.">format_set_border()</a> for details on the border styles. </p>

</div>
</div>
<a id="a21f80d92069d1c0a422daa954c4c6eaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21f80d92069d1c0a422daa954c4c6eaa">&#9670;&nbsp;</a></span>format_set_left()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_left </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>Border style index.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the cell left border style. See <a class="el" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca" title="Set the cell border style.">format_set_border()</a> for details on the border styles. </p>

</div>
</div>
<a id="a4deaaa289159778326c8eb901c70fbb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4deaaa289159778326c8eb901c70fbb9">&#9670;&nbsp;</a></span>format_set_right()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_right </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>Border style index.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the cell right border style. See <a class="el" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca" title="Set the cell border style.">format_set_border()</a> for details on the border styles. </p>

</div>
</div>
<a id="ad8fa6d2b638012fc6e331fcd5cf4266b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8fa6d2b638012fc6e331fcd5cf4266b">&#9670;&nbsp;</a></span>format_set_border_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_border_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell border color.</td></tr>
  </table>
  </dd>
</dl>
<p>Individual border elements can be configured using the following methods with the same parameters:</p>
<ul>
<li><a class="el" href="format_8h.html#a53d5df0f55f154b1019e19f7db3f7df3" title="Set the color of the bottom cell border.">format_set_bottom_color()</a></li>
<li><a class="el" href="format_8h.html#af1126cbf0f5d4a5832d251572566335e" title="Set the color of the top cell border.">format_set_top_color()</a></li>
<li><a class="el" href="format_8h.html#a72ae1cd4040cc5d8b6c7b10697fe982a" title="Set the color of the left cell border.">format_set_left_color()</a></li>
<li><a class="el" href="format_8h.html#a8b1965f2420d7803b6ad5d5b33ce73a9" title="Set the color of the right cell border.">format_set_right_color()</a></li>
</ul>
<p>Set the color of the cell borders. A cell border is comprised of a border on the bottom, top, left and right. These can be set to the same color using <a class="el" href="format_8h.html#ad8fa6d2b638012fc6e331fcd5cf4266b" title="Set the color of the cell border.">format_set_border_color()</a> or individually using the relevant method calls shown above.</p>
<p>The color should be an RGB integer value, see <a class="el" href="working_with_colors.html">Working with Colors</a>. </p>

</div>
</div>
<a id="a53d5df0f55f154b1019e19f7db3f7df3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53d5df0f55f154b1019e19f7db3f7df3">&#9670;&nbsp;</a></span>format_set_bottom_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_bottom_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell border color.</td></tr>
  </table>
  </dd>
</dl>
<p>See <a class="el" href="format_8h.html#ad8fa6d2b638012fc6e331fcd5cf4266b" title="Set the color of the cell border.">format_set_border_color()</a> for details on the border colors. </p>

</div>
</div>
<a id="af1126cbf0f5d4a5832d251572566335e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1126cbf0f5d4a5832d251572566335e">&#9670;&nbsp;</a></span>format_set_top_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_top_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell border color.</td></tr>
  </table>
  </dd>
</dl>
<p>See <a class="el" href="format_8h.html#ad8fa6d2b638012fc6e331fcd5cf4266b" title="Set the color of the cell border.">format_set_border_color()</a> for details on the border colors. </p>

</div>
</div>
<a id="a72ae1cd4040cc5d8b6c7b10697fe982a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72ae1cd4040cc5d8b6c7b10697fe982a">&#9670;&nbsp;</a></span>format_set_left_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_left_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell border color.</td></tr>
  </table>
  </dd>
</dl>
<p>See <a class="el" href="format_8h.html#ad8fa6d2b638012fc6e331fcd5cf4266b" title="Set the color of the cell border.">format_set_border_color()</a> for details on the border colors. </p>

</div>
</div>
<a id="a8b1965f2420d7803b6ad5d5b33ce73a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b1965f2420d7803b6ad5d5b33ce73a9">&#9670;&nbsp;</a></span>format_set_right_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_right_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell border color.</td></tr>
  </table>
  </dd>
</dl>
<p>See <a class="el" href="format_8h.html#ad8fa6d2b638012fc6e331fcd5cf4266b" title="Set the color of the cell border.">format_set_border_color()</a> for details on the border colors. </p>

</div>
</div>
<a id="a1bd8ade5206d187f4f790dbb004ca129"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bd8ade5206d187f4f790dbb004ca129">&#9670;&nbsp;</a></span>format_set_diag_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_diag_type </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>type</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">type</td><td>The <a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2">lxw_format_diagonal_types</a> diagonal border type.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the diagonal cell border type:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__format.html">lxw_format</a> *format1 = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a1bd8ade5206d187f4f790dbb004ca129">format_set_diag_type</a>(  format1, <a class="code" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6a89bbf04376eb234e9d21c58cf4bbb3">LXW_DIAGONAL_BORDER_UP</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="structlxw__format.html">lxw_format</a> *format2 = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a1bd8ade5206d187f4f790dbb004ca129">format_set_diag_type</a>(  format2, <a class="code" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6f8e8c0f88fb619742db3694d65c8d88">LXW_DIAGONAL_BORDER_DOWN</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="structlxw__format.html">lxw_format</a> *format3 = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a1bd8ade5206d187f4f790dbb004ca129">format_set_diag_type</a>(  format3, <a class="code" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2ac9cfa140f5f9960014d4d46e1099a6ba">LXW_DIAGONAL_BORDER_UP_DOWN</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="structlxw__format.html">lxw_format</a> *format4 = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"><a class="code" href="format_8h.html#a1bd8ade5206d187f4f790dbb004ca129">format_set_diag_type</a>(  format4, <a class="code" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2ac9cfa140f5f9960014d4d46e1099a6ba">LXW_DIAGONAL_BORDER_UP_DOWN</a>);</div>
<div class="line"><a class="code" href="format_8h.html#a60a053a40e1e70d5ad4a6171458a360a">format_set_diag_border</a>(format4, <a class="code" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fae7797837ba422a1906eae45fc70c433b">LXW_BORDER_HAIR</a>);</div>
<div class="line"><a class="code" href="format_8h.html#abfffdfb19f1c5bf6ad95a1b40cec2d35">format_set_diag_color</a>( format4, <a class="code" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec">LXW_COLOR_RED</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;B3&quot;</span>),  <span class="stringliteral">&quot;Text&quot;</span>, format1);</div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;B6&quot;</span>),  <span class="stringliteral">&quot;Text&quot;</span>, format2);</div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;B9&quot;</span>),  <span class="stringliteral">&quot;Text&quot;</span>, format3);</div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;B12&quot;</span>), <span class="stringliteral">&quot;Text&quot;</span>, format4);</div>
</div><!-- fragment --><div class="image">
<img src="diagonal_border.png" alt=""/>
</div>
<p>The allowable border types are defined in <a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2">lxw_format_diagonal_types</a>:</p>
<ul>
<li><a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6a89bbf04376eb234e9d21c58cf4bbb3">LXW_DIAGONAL_BORDER_UP</a>: Cell diagonal border from bottom left to top right.</li>
<li><a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6f8e8c0f88fb619742db3694d65c8d88">LXW_DIAGONAL_BORDER_DOWN</a>: Cell diagonal border from top left to bottom right.</li>
<li><a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2ac9cfa140f5f9960014d4d46e1099a6ba">LXW_DIAGONAL_BORDER_UP_DOWN</a>: Cell diagonal border from top left to bottom right. A combination of the 2 previous types.</li>
</ul>
<p>If the border style isn't specified with <code><a class="el" href="format_8h.html#a60a053a40e1e70d5ad4a6171458a360a" title="Set the diagonal cell border style.">format_set_diag_border()</a></code> then it will default to <a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa7ca212fb42e5816bb81d7b96ff623082">LXW_BORDER_THIN</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="diagonal_border_8c-example.html#a6">diagonal_border.c</a>.</dd>
</dl>

</div>
</div>
<a id="a60a053a40e1e70d5ad4a6171458a360a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60a053a40e1e70d5ad4a6171458a360a">&#9670;&nbsp;</a></span>format_set_diag_border()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_diag_border </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>style</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">style</td><td>The <a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8f">lxw_format_borders</a> style.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the diagonal border style. This should be a <a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8f">lxw_format_borders</a> value. See the example above. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="diagonal_border_8c-example.html#a10">diagonal_border.c</a>.</dd>
</dl>

</div>
</div>
<a id="abfffdfb19f1c5bf6ad95a1b40cec2d35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfffdfb19f1c5bf6ad95a1b40cec2d35">&#9670;&nbsp;</a></span>format_set_diag_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void format_set_diag_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlxw__format.html">lxw_format</a> *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td>
          <td class="paramname"><em>color</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Pointer to a Format instance. </td></tr>
    <tr><td class="paramname">color</td><td>The cell diagonal border color.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the diagonal border color. The color should be an RGB integer value, see <a class="el" href="working_with_colors.html">Working with Colors</a> and the above example. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="diagonal_border_8c-example.html#a12">diagonal_border.c</a>.</dd>
</dl>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a34a05058edd856109e5bcf1cc6739fc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34a05058edd856109e5bcf1cc6739fc9">&#9670;&nbsp;</a></span>lxw_color_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef uint32_t <a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The type for RGB colors in libxlsxwriter. The valid range is <code>0x000000</code> (black) to <code>0xFFFFFF</code> (white). See <a class="el" href="working_with_colors.html">Working with Colors</a>. </p>

</div>
</div>
<a id="a5c3981208180a3fff63a834bddfa3200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c3981208180a3fff63a834bddfa3200">&#9670;&nbsp;</a></span>lxw_format</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structlxw__format.html">lxw_format</a> <a class="el" href="structlxw__format.html">lxw_format</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Formats in <code>libxlsxwriter</code> are accessed via this struct.</p>
<p>The members of the <a class="el" href="structlxw__format.html" title="Struct to represent the formatting properties of an Excel format.">lxw_format</a> struct aren't modified directly. Instead the format properties are set by calling the functions shown in <a class="el" href="format_8h.html" title="Functions and properties for adding formatting to cells in Excel.">format.h</a>.</p>
<p>For example:</p>
<div class="fragment"><div class="line"><span class="comment">// Create the Format.</span></div>
<div class="line"><a class="code" href="structlxw__format.html">lxw_format</a> *format = <a class="code" href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a>(workbook);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set some of the format properties.</span></div>
<div class="line"><a class="code" href="format_8h.html#a85e1b0baf44b445b65894e48722aec14">format_set_bold</a>(format);</div>
<div class="line"><a class="code" href="format_8h.html#a61981b2080bfe6381ede5358ee05b05c">format_set_font_color</a>(format, <a class="code" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec">LXW_COLOR_RED</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Use the format to change the text format in a cell.</span></div>
<div class="line"><a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>(worksheet, 0, 0, <span class="stringliteral">&quot;Hello&quot;</span>, format);</div>
</div><!-- fragment --> 
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="af530d7971d15c164f3fb6bbfede9a39f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af530d7971d15c164f3fb6bbfede9a39f">&#9670;&nbsp;</a></span>lxw_format_underlines</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39f">lxw_format_underlines</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Format underline values for <a class="el" href="format_8h.html#ad35ee5445826bd93ec1bc0d489fc09db" title="Turn on underline for the format:">format_set_underline()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af530d7971d15c164f3fb6bbfede9a39fa76d5bdd1c57c126df937f0b003597e18"></a>LXW_UNDERLINE_SINGLE&#160;</td><td class="fielddoc"><p>Single underline </p>
</td></tr>
<tr><td class="fieldname"><a id="af530d7971d15c164f3fb6bbfede9a39fa578bcd2c45f3d549fcfc46937550de13"></a>LXW_UNDERLINE_DOUBLE&#160;</td><td class="fielddoc"><p>Double underline </p>
</td></tr>
<tr><td class="fieldname"><a id="af530d7971d15c164f3fb6bbfede9a39faac874d8fee3376d3e989ca008001f6ed"></a>LXW_UNDERLINE_SINGLE_ACCOUNTING&#160;</td><td class="fielddoc"><p>Single accounting underline </p>
</td></tr>
<tr><td class="fieldname"><a id="af530d7971d15c164f3fb6bbfede9a39fa63088febe121487e7269d6aedcafa628"></a>LXW_UNDERLINE_DOUBLE_ACCOUNTING&#160;</td><td class="fielddoc"><p>Double accounting underline </p>
</td></tr>
</table>

</div>
</div>
<a id="a0ff8fd761893f60fddbd7f1cab4ac75a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ff8fd761893f60fddbd7f1cab4ac75a">&#9670;&nbsp;</a></span>lxw_format_scripts</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="format_8h.html#a0ff8fd761893f60fddbd7f1cab4ac75a">lxw_format_scripts</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Superscript and subscript values for <a class="el" href="format_8h.html#a471ca432e429505c79982ca5aecd1db0" title="Set the superscript/subscript property of the font.">format_set_font_script()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0ff8fd761893f60fddbd7f1cab4ac75aa191621e73f0f2837147d221ed5f06034"></a>LXW_FONT_SUPERSCRIPT&#160;</td><td class="fielddoc"><p>Superscript font </p>
</td></tr>
<tr><td class="fieldname"><a id="a0ff8fd761893f60fddbd7f1cab4ac75aa38cf7f98c69b63c30194c5907f8397ec"></a>LXW_FONT_SUBSCRIPT&#160;</td><td class="fielddoc"><p>Subscript font </p>
</td></tr>
</table>

</div>
</div>
<a id="adeeb0d70c7c873422d642323e7e1ecf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeeb0d70c7c873422d642323e7e1ecf5">&#9670;&nbsp;</a></span>lxw_format_alignments</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5">lxw_format_alignments</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Alignment values for <a class="el" href="format_8h.html#a189c83d1f21b01937f1f730720c33d13" title="Set the alignment for data in the cell.">format_set_align()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5ad494c53e03b10703d1973403a58ce962"></a>LXW_ALIGN_NONE&#160;</td><td class="fielddoc"><p>No alignment. Cell will use Excel's default for the data type </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5a6d528fd0486c22c04941cd8ed1bbc8e1"></a>LXW_ALIGN_LEFT&#160;</td><td class="fielddoc"><p>Left horizontal alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5a9899936ef3a43721b394b9b5d2314496"></a>LXW_ALIGN_CENTER&#160;</td><td class="fielddoc"><p>Center horizontal alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5acae72c15765797c03572554f57c82aa9"></a>LXW_ALIGN_RIGHT&#160;</td><td class="fielddoc"><p>Right horizontal alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5acfd1c600aa60d19d25b1026e7fa7fe1e"></a>LXW_ALIGN_FILL&#160;</td><td class="fielddoc"><p>Cell fill horizontal alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5a20ed1a57601ce09f6885fef25e63a660"></a>LXW_ALIGN_JUSTIFY&#160;</td><td class="fielddoc"><p>Justify horizontal alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5ae1400bbf14fd49d4e3525f479a5f55f0"></a>LXW_ALIGN_CENTER_ACROSS&#160;</td><td class="fielddoc"><p>Center Across horizontal alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5a1ff90b4c61e058bf2254f43e534d9c57"></a>LXW_ALIGN_DISTRIBUTED&#160;</td><td class="fielddoc"><p>Left horizontal alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5a9c365c63356bb50e4d6db97f59526b17"></a>LXW_ALIGN_VERTICAL_TOP&#160;</td><td class="fielddoc"><p>Top vertical alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5ab7dd1a8e22e59928d6258a7d3d44b0c7"></a>LXW_ALIGN_VERTICAL_BOTTOM&#160;</td><td class="fielddoc"><p>Bottom vertical alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5ae0a52569d3110521d3e9341809336063"></a>LXW_ALIGN_VERTICAL_CENTER&#160;</td><td class="fielddoc"><p>Center vertical alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5a4940e5aa8e07a9d659d1cf6c2785286f"></a>LXW_ALIGN_VERTICAL_JUSTIFY&#160;</td><td class="fielddoc"><p>Justify vertical alignment </p>
</td></tr>
<tr><td class="fieldname"><a id="adeeb0d70c7c873422d642323e7e1ecf5ae456bcbbc14b0c142b808c49950ff710"></a>LXW_ALIGN_VERTICAL_DISTRIBUTED&#160;</td><td class="fielddoc"><p>Distributed vertical alignment </p>
</td></tr>
</table>

</div>
</div>
<a id="add9c45d94b8c1d29e69b37278384fae2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add9c45d94b8c1d29e69b37278384fae2">&#9670;&nbsp;</a></span>lxw_format_diagonal_types</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2">lxw_format_diagonal_types</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Diagonal border types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="add9c45d94b8c1d29e69b37278384fae2a6a89bbf04376eb234e9d21c58cf4bbb3"></a>LXW_DIAGONAL_BORDER_UP&#160;</td><td class="fielddoc"><p>Cell diagonal border from bottom left to top right. </p>
</td></tr>
<tr><td class="fieldname"><a id="add9c45d94b8c1d29e69b37278384fae2a6f8e8c0f88fb619742db3694d65c8d88"></a>LXW_DIAGONAL_BORDER_DOWN&#160;</td><td class="fielddoc"><p>Cell diagonal border from top left to bottom right. </p>
</td></tr>
<tr><td class="fieldname"><a id="add9c45d94b8c1d29e69b37278384fae2ac9cfa140f5f9960014d4d46e1099a6ba"></a>LXW_DIAGONAL_BORDER_UP_DOWN&#160;</td><td class="fielddoc"><p>Cell diagonal border in both directions. </p>
</td></tr>
</table>

</div>
</div>
<a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeafc6e8222ba9fcfd4f2c2f4e9ea38b">&#9670;&nbsp;</a></span>lxw_defined_colors</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38b">lxw_defined_colors</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Predefined values for common colors. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba13bdb1312b42e892cd29dfeb79ec8451"></a>LXW_COLOR_BLACK&#160;</td><td class="fielddoc"><p>Black </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba81f6ca72c0925fe665263547614ebb37"></a>LXW_COLOR_BLUE&#160;</td><td class="fielddoc"><p>Blue </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38bac7d0a878a1d72bd2f17c50bc41af6bd0"></a>LXW_COLOR_BROWN&#160;</td><td class="fielddoc"><p>Brown </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba1debfae936d05272324e9a7d1f092093"></a>LXW_COLOR_CYAN&#160;</td><td class="fielddoc"><p>Cyan </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba9d8f4d0a626d45d0f89fb4d404b592c0"></a>LXW_COLOR_GRAY&#160;</td><td class="fielddoc"><p>Gray </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871"></a>LXW_COLOR_GREEN&#160;</td><td class="fielddoc"><p>Green </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba159829f690cde36c2aa2ec3e1e4b79d1"></a>LXW_COLOR_LIME&#160;</td><td class="fielddoc"><p>Lime </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba52330ab8ca0f60e106043cb340cedd73"></a>LXW_COLOR_MAGENTA&#160;</td><td class="fielddoc"><p>Magenta </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba5f9a9111c59f09167d9d79cc4750a7f3"></a>LXW_COLOR_NAVY&#160;</td><td class="fielddoc"><p>Navy </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba4d686a30e8e3b7d23dc6424f1f5bf679"></a>LXW_COLOR_ORANGE&#160;</td><td class="fielddoc"><p>Orange </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38baba59ce674c5923f4987095897a4bfa69"></a>LXW_COLOR_PINK&#160;</td><td class="fielddoc"><p>Pink </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba326d6f6b69afcd709e02aa17f72130ed"></a>LXW_COLOR_PURPLE&#160;</td><td class="fielddoc"><p>Purple </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec"></a>LXW_COLOR_RED&#160;</td><td class="fielddoc"><p>Red </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38baf986b48f94200c9d4e7ee85013805e33"></a>LXW_COLOR_SILVER&#160;</td><td class="fielddoc"><p>Silver </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38ba77f6d9e520849cf6c25a7f33cf303da2"></a>LXW_COLOR_WHITE&#160;</td><td class="fielddoc"><p>White </p>
</td></tr>
<tr><td class="fieldname"><a id="abeafc6e8222ba9fcfd4f2c2f4e9ea38baebda4f169497f225a9c67bb51691c095"></a>LXW_COLOR_YELLOW&#160;</td><td class="fielddoc"><p>Yellow </p>
</td></tr>
</table>

</div>
</div>
<a id="a40e28394b961e69d4bee27579b4476e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40e28394b961e69d4bee27579b4476e7">&#9670;&nbsp;</a></span>lxw_format_patterns</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7">lxw_format_patterns</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Pattern value for use with <a class="el" href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a" title="Set the background fill pattern for a cell.">format_set_pattern()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a8ea9d9b7686442f43da92dff3745adc3"></a>LXW_PATTERN_NONE&#160;</td><td class="fielddoc"><p>Empty pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a1fbd6761c4ccd57d98dfd59eaad9fde5"></a>LXW_PATTERN_SOLID&#160;</td><td class="fielddoc"><p>Solid pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7af2abac6c05ed8772c2a21d95bce0c332"></a>LXW_PATTERN_MEDIUM_GRAY&#160;</td><td class="fielddoc"><p>Medium gray pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a7d852861b5d7206be22b15d9fccb024e"></a>LXW_PATTERN_DARK_GRAY&#160;</td><td class="fielddoc"><p>Dark gray pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a9de2f62c80744dbe9d0f30328d5e8abd"></a>LXW_PATTERN_LIGHT_GRAY&#160;</td><td class="fielddoc"><p>Light gray pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a7cc5d51af6a1e10fddba733b9e4bd732"></a>LXW_PATTERN_DARK_HORIZONTAL&#160;</td><td class="fielddoc"><p>Dark horizontal line pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a955a27466845e6c68c097e78cd9772ae"></a>LXW_PATTERN_DARK_VERTICAL&#160;</td><td class="fielddoc"><p>Dark vertical line pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a704f3f128794e0bedec3635862e25211"></a>LXW_PATTERN_DARK_DOWN&#160;</td><td class="fielddoc"><p>Dark diagonal stripe pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a107513419af030ee56d05ae6b5dbb528"></a>LXW_PATTERN_DARK_UP&#160;</td><td class="fielddoc"><p>Reverse dark diagonal stripe pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a44857e548d3a18290dac9e71addc6291"></a>LXW_PATTERN_DARK_GRID&#160;</td><td class="fielddoc"><p>Dark grid pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a2fd1863ff664b2df2bbba4361c92fdca"></a>LXW_PATTERN_DARK_TRELLIS&#160;</td><td class="fielddoc"><p>Dark trellis pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a324406f6c68917ffae078e8e329d182a"></a>LXW_PATTERN_LIGHT_HORIZONTAL&#160;</td><td class="fielddoc"><p>Light horizontal Line pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a2c064fc89708395070cebadaaa78b55d"></a>LXW_PATTERN_LIGHT_VERTICAL&#160;</td><td class="fielddoc"><p>Light vertical line pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7ab17dcd0ae9f99188f60e36c26fbc1d83"></a>LXW_PATTERN_LIGHT_DOWN&#160;</td><td class="fielddoc"><p>Light diagonal stripe pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7ab81adfee485941ecba5c0dd93f643592"></a>LXW_PATTERN_LIGHT_UP&#160;</td><td class="fielddoc"><p>Reverse light diagonal stripe pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a9e16acce0752307d5e05f76740883b11"></a>LXW_PATTERN_LIGHT_GRID&#160;</td><td class="fielddoc"><p>Light grid pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a4b8228b008c86da617c35e34ec6abd11"></a>LXW_PATTERN_LIGHT_TRELLIS&#160;</td><td class="fielddoc"><p>Light trellis pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7ac2f4e6b63f812c6a93ec2dfa9ff26498"></a>LXW_PATTERN_GRAY_125&#160;</td><td class="fielddoc"><p>12.5% gray pattern </p>
</td></tr>
<tr><td class="fieldname"><a id="a40e28394b961e69d4bee27579b4476e7a2d6d7aa016cb7468e5207a20eefb3f4f"></a>LXW_PATTERN_GRAY_0625&#160;</td><td class="fielddoc"><p>6.25% gray pattern </p>
</td></tr>
</table>

</div>
</div>
<a id="a4d5e924b1acd9571fd5e0fe2615e9f8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d5e924b1acd9571fd5e0fe2615e9f8f">&#9670;&nbsp;</a></span>lxw_format_borders</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8f">lxw_format_borders</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Cell border styles for use with <a class="el" href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca" title="Set the cell border style.">format_set_border()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fafa0d7e8a760e8b967337ee03e27df552"></a>LXW_BORDER_NONE&#160;</td><td class="fielddoc"><p>No border </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fa7ca212fb42e5816bb81d7b96ff623082"></a>LXW_BORDER_THIN&#160;</td><td class="fielddoc"><p>Thin border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8faf13965852c4b271b6cc58b74a0888ca1"></a>LXW_BORDER_MEDIUM&#160;</td><td class="fielddoc"><p>Medium border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fa27dd64afac6a3adf97afbb2f467f70c7"></a>LXW_BORDER_DASHED&#160;</td><td class="fielddoc"><p>Dashed border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fa497a0e380b7b4b271291ccf45bd15cd8"></a>LXW_BORDER_DOTTED&#160;</td><td class="fielddoc"><p>Dotted border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fac837bde417fcfd8ff116ed1f188f4093"></a>LXW_BORDER_THICK&#160;</td><td class="fielddoc"><p>Thick border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fafee0fd8f4ad9a64420efae0004448911"></a>LXW_BORDER_DOUBLE&#160;</td><td class="fielddoc"><p>Double border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fae7797837ba422a1906eae45fc70c433b"></a>LXW_BORDER_HAIR&#160;</td><td class="fielddoc"><p>Hair border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fa43e260c910dd9701593c9d208a4d8e43"></a>LXW_BORDER_MEDIUM_DASHED&#160;</td><td class="fielddoc"><p>Medium dashed border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fad6da2db66cdef3442012a64bd47084e5"></a>LXW_BORDER_DASH_DOT&#160;</td><td class="fielddoc"><p>Dash-dot border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fa1227f361693ea996e1812d00e335e5c9"></a>LXW_BORDER_MEDIUM_DASH_DOT&#160;</td><td class="fielddoc"><p>Medium dash-dot border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fa89c80e0b6bc3c632aefcb71fa25ccc31"></a>LXW_BORDER_DASH_DOT_DOT&#160;</td><td class="fielddoc"><p>Dash-dot-dot border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8faf3b32f72854987702eed3b28d59d6eb6"></a>LXW_BORDER_MEDIUM_DASH_DOT_DOT&#160;</td><td class="fielddoc"><p>Medium dash-dot-dot border style </p>
</td></tr>
<tr><td class="fieldname"><a id="a4d5e924b1acd9571fd5e0fe2615e9f8fad6eb5faf3a43fc6d9546c433afd3a903"></a>LXW_BORDER_SLANT_DASH_DOT&#160;</td><td class="fielddoc"><p>Slant dash-dot border style </p>
</td></tr>
</table>

</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__format.html">lxw_format</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct to represent the formatting properties of an Excel format.  <a href="structlxw__format.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a34a05058edd856109e5bcf1cc6739fc9"><td class="memItemLeft" align="right" valign="top">typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a></td></tr>
<tr class="memdesc:a34a05058edd856109e5bcf1cc6739fc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type for RGB colors in libxlsxwriter.  <a href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">More...</a><br /></td></tr>
<tr class="separator:a34a05058edd856109e5bcf1cc6739fc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c3981208180a3fff63a834bddfa3200"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structlxw__format.html">lxw_format</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a5c3981208180a3fff63a834bddfa3200">lxw_format</a></td></tr>
<tr class="memdesc:a5c3981208180a3fff63a834bddfa3200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct to represent the formatting properties of an Excel format.  <a href="format_8h.html#a5c3981208180a3fff63a834bddfa3200">More...</a><br /></td></tr>
<tr class="separator:a5c3981208180a3fff63a834bddfa3200"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:af530d7971d15c164f3fb6bbfede9a39f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39f">lxw_format_underlines</a> { , <a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa76d5bdd1c57c126df937f0b003597e18">LXW_UNDERLINE_SINGLE</a>, 
<a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa578bcd2c45f3d549fcfc46937550de13">LXW_UNDERLINE_DOUBLE</a>, 
<a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39faac874d8fee3376d3e989ca008001f6ed">LXW_UNDERLINE_SINGLE_ACCOUNTING</a>, 
<a class="el" href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa63088febe121487e7269d6aedcafa628">LXW_UNDERLINE_DOUBLE_ACCOUNTING</a>
 }</td></tr>
<tr class="separator:af530d7971d15c164f3fb6bbfede9a39f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ff8fd761893f60fddbd7f1cab4ac75a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a0ff8fd761893f60fddbd7f1cab4ac75a">lxw_format_scripts</a> { <a class="el" href="format_8h.html#a0ff8fd761893f60fddbd7f1cab4ac75aa191621e73f0f2837147d221ed5f06034">LXW_FONT_SUPERSCRIPT</a> = 1, 
<a class="el" href="format_8h.html#a0ff8fd761893f60fddbd7f1cab4ac75aa38cf7f98c69b63c30194c5907f8397ec">LXW_FONT_SUBSCRIPT</a>
 }</td></tr>
<tr class="separator:a0ff8fd761893f60fddbd7f1cab4ac75a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeeb0d70c7c873422d642323e7e1ecf5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5">lxw_format_alignments</a> { <br />
&#160;&#160;<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ad494c53e03b10703d1973403a58ce962">LXW_ALIGN_NONE</a> = 0, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a6d528fd0486c22c04941cd8ed1bbc8e1">LXW_ALIGN_LEFT</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a9899936ef3a43721b394b9b5d2314496">LXW_ALIGN_CENTER</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5acae72c15765797c03572554f57c82aa9">LXW_ALIGN_RIGHT</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5acfd1c600aa60d19d25b1026e7fa7fe1e">LXW_ALIGN_FILL</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a20ed1a57601ce09f6885fef25e63a660">LXW_ALIGN_JUSTIFY</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae1400bbf14fd49d4e3525f479a5f55f0">LXW_ALIGN_CENTER_ACROSS</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a1ff90b4c61e058bf2254f43e534d9c57">LXW_ALIGN_DISTRIBUTED</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a9c365c63356bb50e4d6db97f59526b17">LXW_ALIGN_VERTICAL_TOP</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ab7dd1a8e22e59928d6258a7d3d44b0c7">LXW_ALIGN_VERTICAL_BOTTOM</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae0a52569d3110521d3e9341809336063">LXW_ALIGN_VERTICAL_CENTER</a>, 
<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a4940e5aa8e07a9d659d1cf6c2785286f">LXW_ALIGN_VERTICAL_JUSTIFY</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae456bcbbc14b0c142b808c49950ff710">LXW_ALIGN_VERTICAL_DISTRIBUTED</a>
<br />
 }</td></tr>
<tr class="separator:adeeb0d70c7c873422d642323e7e1ecf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add9c45d94b8c1d29e69b37278384fae2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2">lxw_format_diagonal_types</a> { <a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6a89bbf04376eb234e9d21c58cf4bbb3">LXW_DIAGONAL_BORDER_UP</a> = 1, 
<a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6f8e8c0f88fb619742db3694d65c8d88">LXW_DIAGONAL_BORDER_DOWN</a>, 
<a class="el" href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2ac9cfa140f5f9960014d4d46e1099a6ba">LXW_DIAGONAL_BORDER_UP_DOWN</a>
 }</td></tr>
<tr class="separator:add9c45d94b8c1d29e69b37278384fae2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeafc6e8222ba9fcfd4f2c2f4e9ea38b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38b">lxw_defined_colors</a> { <br />
&#160;&#160;<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba13bdb1312b42e892cd29dfeb79ec8451">LXW_COLOR_BLACK</a> = 0x1000000, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba81f6ca72c0925fe665263547614ebb37">LXW_COLOR_BLUE</a> = 0x0000FF, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38bac7d0a878a1d72bd2f17c50bc41af6bd0">LXW_COLOR_BROWN</a> = 0x800000, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba1debfae936d05272324e9a7d1f092093">LXW_COLOR_CYAN</a> = 0x00FFFF, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba9d8f4d0a626d45d0f89fb4d404b592c0">LXW_COLOR_GRAY</a> = 0x808080, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871">LXW_COLOR_GREEN</a> = 0x008000, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba159829f690cde36c2aa2ec3e1e4b79d1">LXW_COLOR_LIME</a> = 0x00FF00, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba52330ab8ca0f60e106043cb340cedd73">LXW_COLOR_MAGENTA</a> = 0xFF00FF, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba5f9a9111c59f09167d9d79cc4750a7f3">LXW_COLOR_NAVY</a> = 0x000080, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba4d686a30e8e3b7d23dc6424f1f5bf679">LXW_COLOR_ORANGE</a> = 0xFF6600, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baba59ce674c5923f4987095897a4bfa69">LXW_COLOR_PINK</a> = 0xFF00FF, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba326d6f6b69afcd709e02aa17f72130ed">LXW_COLOR_PURPLE</a> = 0x800080, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec">LXW_COLOR_RED</a> = 0xFF0000, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baf986b48f94200c9d4e7ee85013805e33">LXW_COLOR_SILVER</a> = 0xC0C0C0, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38ba77f6d9e520849cf6c25a7f33cf303da2">LXW_COLOR_WHITE</a> = 0xFFFFFF, 
<a class="el" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baebda4f169497f225a9c67bb51691c095">LXW_COLOR_YELLOW</a> = 0xFFFF00
<br />
 }</td></tr>
<tr class="separator:abeafc6e8222ba9fcfd4f2c2f4e9ea38b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40e28394b961e69d4bee27579b4476e7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7">lxw_format_patterns</a> { <br />
&#160;&#160;<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a8ea9d9b7686442f43da92dff3745adc3">LXW_PATTERN_NONE</a> = 0, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a1fbd6761c4ccd57d98dfd59eaad9fde5">LXW_PATTERN_SOLID</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7af2abac6c05ed8772c2a21d95bce0c332">LXW_PATTERN_MEDIUM_GRAY</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a7d852861b5d7206be22b15d9fccb024e">LXW_PATTERN_DARK_GRAY</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a9de2f62c80744dbe9d0f30328d5e8abd">LXW_PATTERN_LIGHT_GRAY</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a7cc5d51af6a1e10fddba733b9e4bd732">LXW_PATTERN_DARK_HORIZONTAL</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a955a27466845e6c68c097e78cd9772ae">LXW_PATTERN_DARK_VERTICAL</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a704f3f128794e0bedec3635862e25211">LXW_PATTERN_DARK_DOWN</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a107513419af030ee56d05ae6b5dbb528">LXW_PATTERN_DARK_UP</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a44857e548d3a18290dac9e71addc6291">LXW_PATTERN_DARK_GRID</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a2fd1863ff664b2df2bbba4361c92fdca">LXW_PATTERN_DARK_TRELLIS</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a324406f6c68917ffae078e8e329d182a">LXW_PATTERN_LIGHT_HORIZONTAL</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a2c064fc89708395070cebadaaa78b55d">LXW_PATTERN_LIGHT_VERTICAL</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7ab17dcd0ae9f99188f60e36c26fbc1d83">LXW_PATTERN_LIGHT_DOWN</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7ab81adfee485941ecba5c0dd93f643592">LXW_PATTERN_LIGHT_UP</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a9e16acce0752307d5e05f76740883b11">LXW_PATTERN_LIGHT_GRID</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a4b8228b008c86da617c35e34ec6abd11">LXW_PATTERN_LIGHT_TRELLIS</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7ac2f4e6b63f812c6a93ec2dfa9ff26498">LXW_PATTERN_GRAY_125</a>, 
<a class="el" href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a2d6d7aa016cb7468e5207a20eefb3f4f">LXW_PATTERN_GRAY_0625</a>
<br />
 }</td></tr>
<tr class="separator:a40e28394b961e69d4bee27579b4476e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d5e924b1acd9571fd5e0fe2615e9f8f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8f">lxw_format_borders</a> { <br />
&#160;&#160;<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fafa0d7e8a760e8b967337ee03e27df552">LXW_BORDER_NONE</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa7ca212fb42e5816bb81d7b96ff623082">LXW_BORDER_THIN</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8faf13965852c4b271b6cc58b74a0888ca1">LXW_BORDER_MEDIUM</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa27dd64afac6a3adf97afbb2f467f70c7">LXW_BORDER_DASHED</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa497a0e380b7b4b271291ccf45bd15cd8">LXW_BORDER_DOTTED</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fac837bde417fcfd8ff116ed1f188f4093">LXW_BORDER_THICK</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fafee0fd8f4ad9a64420efae0004448911">LXW_BORDER_DOUBLE</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fae7797837ba422a1906eae45fc70c433b">LXW_BORDER_HAIR</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa43e260c910dd9701593c9d208a4d8e43">LXW_BORDER_MEDIUM_DASHED</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fad6da2db66cdef3442012a64bd47084e5">LXW_BORDER_DASH_DOT</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa1227f361693ea996e1812d00e335e5c9">LXW_BORDER_MEDIUM_DASH_DOT</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa89c80e0b6bc3c632aefcb71fa25ccc31">LXW_BORDER_DASH_DOT_DOT</a>, 
<br />
&#160;&#160;<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8faf3b32f72854987702eed3b28d59d6eb6">LXW_BORDER_MEDIUM_DASH_DOT_DOT</a>, 
<a class="el" href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fad6eb5faf3a43fc6d9546c433afd3a903">LXW_BORDER_SLANT_DASH_DOT</a>
<br />
 }</td></tr>
<tr class="separator:a4d5e924b1acd9571fd5e0fe2615e9f8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<div class="ttc" id="aformat_8h_html_a688aa42bcc703d17e125d9a34c721872"><div class="ttname"><a href="format_8h.html#a688aa42bcc703d17e125d9a34c721872">format_set_num_format_index</a></div><div class="ttdeci">void format_set_num_format_index(lxw_format *format, uint8_t index)</div><div class="ttdoc">Set the Excel built-in number format for a cell.</div></div>
<div class="ttc" id="aformat_8h_html_a8fc47dd0e47020358c79e20039cbd760"><div class="ttname"><a href="format_8h.html#a8fc47dd0e47020358c79e20039cbd760">format_set_shrink</a></div><div class="ttdeci">void format_set_shrink(lxw_format *format)</div><div class="ttdoc">Turn on the text &quot;shrink to fit&quot; for a cell.</div></div>
<div class="ttc" id="aformat_8h_html_a56d55dd9257d8f0645c62b296d2c196d"><div class="ttname"><a href="format_8h.html#a56d55dd9257d8f0645c62b296d2c196d">format_set_text_wrap</a></div><div class="ttdeci">void format_set_text_wrap(lxw_format *format)</div><div class="ttdoc">Wrap text in a cell.</div></div>
<div class="ttc" id="aformat_8h_html_aec5c1028fa3e25ad60e439fd64afb245"><div class="ttname"><a href="format_8h.html#aec5c1028fa3e25ad60e439fd64afb245">format_set_font_size</a></div><div class="ttdeci">void format_set_font_size(lxw_format *format, double size)</div><div class="ttdoc">Set the size of the font used in the cell.</div></div>
<div class="ttc" id="aformat_8h_html_add9c45d94b8c1d29e69b37278384fae2a6f8e8c0f88fb619742db3694d65c8d88"><div class="ttname"><a href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6f8e8c0f88fb619742db3694d65c8d88">LXW_DIAGONAL_BORDER_DOWN</a></div><div class="ttdeci">@ LXW_DIAGONAL_BORDER_DOWN</div><div class="ttdef"><b>Definition:</b> format.h:172</div></div>
<div class="ttc" id="aformat_8h_html_a19cbd7c34692eb7fb35a7411432d836e"><div class="ttname"><a href="format_8h.html#a19cbd7c34692eb7fb35a7411432d836e">format_set_italic</a></div><div class="ttdeci">void format_set_italic(lxw_format *format)</div><div class="ttdoc">Turn on italic for the format font.</div></div>
<div class="ttc" id="aformat_8h_html_a1dfd61b72aab2c28c3d51e53e08df587"><div class="ttname"><a href="format_8h.html#a1dfd61b72aab2c28c3d51e53e08df587">format_set_unlocked</a></div><div class="ttdeci">void format_set_unlocked(lxw_format *format)</div><div class="ttdoc">Set the cell unlocked state.</div></div>
<div class="ttc" id="aformat_8h_html_adeeb0d70c7c873422d642323e7e1ecf5ae0a52569d3110521d3e9341809336063"><div class="ttname"><a href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5ae0a52569d3110521d3e9341809336063">LXW_ALIGN_VERTICAL_CENTER</a></div><div class="ttdeci">@ LXW_ALIGN_VERTICAL_CENTER</div><div class="ttdef"><b>Definition:</b> format.h:153</div></div>
<div class="ttc" id="aworksheet_8h_html_ae57117f04c82bef29805ec3eabc219bb"><div class="ttname"><a href="worksheet_8h.html#ae57117f04c82bef29805ec3eabc219bb">worksheet_write_formula</a></div><div class="ttdeci">lxw_error worksheet_write_formula(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, const char *formula, lxw_format *format)</div><div class="ttdoc">Write a formula to a worksheet cell.</div></div>
<div class="ttc" id="aformat_8h_html_a189c83d1f21b01937f1f730720c33d13"><div class="ttname"><a href="format_8h.html#a189c83d1f21b01937f1f730720c33d13">format_set_align</a></div><div class="ttdeci">void format_set_align(lxw_format *format, uint8_t alignment)</div><div class="ttdoc">Set the alignment for data in the cell.</div></div>
<div class="ttc" id="aformat_8h_html_add9c45d94b8c1d29e69b37278384fae2a6a89bbf04376eb234e9d21c58cf4bbb3"><div class="ttname"><a href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2a6a89bbf04376eb234e9d21c58cf4bbb3">LXW_DIAGONAL_BORDER_UP</a></div><div class="ttdeci">@ LXW_DIAGONAL_BORDER_UP</div><div class="ttdef"><b>Definition:</b> format.h:169</div></div>
<div class="ttc" id="aformat_8h_html_a60a053a40e1e70d5ad4a6171458a360a"><div class="ttname"><a href="format_8h.html#a60a053a40e1e70d5ad4a6171458a360a">format_set_diag_border</a></div><div class="ttdeci">void format_set_diag_border(lxw_format *format, uint8_t style)</div><div class="ttdoc">Set the diagonal cell border style.</div></div>
<div class="ttc" id="aformat_8h_html_a9cf7a28a6e8014cb98dff27415e2b1ca"><div class="ttname"><a href="format_8h.html#a9cf7a28a6e8014cb98dff27415e2b1ca">format_set_border</a></div><div class="ttdeci">void format_set_border(lxw_format *format, uint8_t style)</div><div class="ttdoc">Set the cell border style.</div></div>
<div class="ttc" id="aformat_8h_html_a85e1b0baf44b445b65894e48722aec14"><div class="ttname"><a href="format_8h.html#a85e1b0baf44b445b65894e48722aec14">format_set_bold</a></div><div class="ttdeci">void format_set_bold(lxw_format *format)</div><div class="ttdoc">Turn on bold for the format font.</div></div>
<div class="ttc" id="aformat_8h_html_abeafc6e8222ba9fcfd4f2c2f4e9ea38baebda4f169497f225a9c67bb51691c095"><div class="ttname"><a href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baebda4f169497f225a9c67bb51691c095">LXW_COLOR_YELLOW</a></div><div class="ttdeci">@ LXW_COLOR_YELLOW</div><div class="ttdef"><b>Definition:</b> format.h:226</div></div>
<div class="ttc" id="aformat_8h_html_af77bbd0003344cb16d455c7fb709e16c"><div class="ttname"><a href="format_8h.html#af77bbd0003344cb16d455c7fb709e16c">format_set_num_format</a></div><div class="ttdeci">void format_set_num_format(lxw_format *format, const char *num_format)</div><div class="ttdoc">Set the number format for a cell.</div></div>
<div class="ttc" id="astructlxw__format_html"><div class="ttname"><a href="structlxw__format.html">lxw_format</a></div><div class="ttdoc">Struct to represent the formatting properties of an Excel format.</div><div class="ttdef"><b>Definition:</b> format.h:358</div></div>
<div class="ttc" id="aworksheet_8h_html_a1b49e135d4debcdb25941f2f40f04cb0"><div class="ttname"><a href="worksheet_8h.html#a1b49e135d4debcdb25941f2f40f04cb0">worksheet_protect</a></div><div class="ttdeci">void worksheet_protect(lxw_worksheet *worksheet, const char *password, lxw_protection *options)</div><div class="ttdoc">Protect elements of a worksheet from modification.</div></div>
<div class="ttc" id="aformat_8h_html_a4d5e924b1acd9571fd5e0fe2615e9f8fae7797837ba422a1906eae45fc70c433b"><div class="ttname"><a href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fae7797837ba422a1906eae45fc70c433b">LXW_BORDER_HAIR</a></div><div class="ttdeci">@ LXW_BORDER_HAIR</div><div class="ttdef"><b>Definition:</b> format.h:313</div></div>
<div class="ttc" id="aformat_8h_html_aeef47436c335daf1801683ac7b3b587d"><div class="ttname"><a href="format_8h.html#aeef47436c335daf1801683ac7b3b587d">format_set_bg_color</a></div><div class="ttdeci">void format_set_bg_color(lxw_format *format, lxw_color_t color)</div><div class="ttdoc">Set the pattern background color for a cell.</div></div>
<div class="ttc" id="aformat_8h_html_adeeb0d70c7c873422d642323e7e1ecf5a9899936ef3a43721b394b9b5d2314496"><div class="ttname"><a href="format_8h.html#adeeb0d70c7c873422d642323e7e1ecf5a9899936ef3a43721b394b9b5d2314496">LXW_ALIGN_CENTER</a></div><div class="ttdeci">@ LXW_ALIGN_CENTER</div><div class="ttdef"><b>Definition:</b> format.h:129</div></div>
<div class="ttc" id="aformat_8h_html_af530d7971d15c164f3fb6bbfede9a39fa76d5bdd1c57c126df937f0b003597e18"><div class="ttname"><a href="format_8h.html#af530d7971d15c164f3fb6bbfede9a39fa76d5bdd1c57c126df937f0b003597e18">LXW_UNDERLINE_SINGLE</a></div><div class="ttdeci">@ LXW_UNDERLINE_SINGLE</div><div class="ttdef"><b>Definition:</b> format.h:98</div></div>
<div class="ttc" id="aformat_8h_html_add9c45d94b8c1d29e69b37278384fae2ac9cfa140f5f9960014d4d46e1099a6ba"><div class="ttname"><a href="format_8h.html#add9c45d94b8c1d29e69b37278384fae2ac9cfa140f5f9960014d4d46e1099a6ba">LXW_DIAGONAL_BORDER_UP_DOWN</a></div><div class="ttdeci">@ LXW_DIAGONAL_BORDER_UP_DOWN</div><div class="ttdef"><b>Definition:</b> format.h:175</div></div>
<div class="ttc" id="aformat_8h_html_abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871"><div class="ttname"><a href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871">LXW_COLOR_GREEN</a></div><div class="ttdeci">@ LXW_COLOR_GREEN</div><div class="ttdef"><b>Definition:</b> format.h:196</div></div>
<div class="ttc" id="aformat_8h_html_a1bd8ade5206d187f4f790dbb004ca129"><div class="ttname"><a href="format_8h.html#a1bd8ade5206d187f4f790dbb004ca129">format_set_diag_type</a></div><div class="ttdeci">void format_set_diag_type(lxw_format *format, uint8_t type)</div><div class="ttdoc">Set the diagonal cell border type.</div></div>
<div class="ttc" id="aformat_8h_html_abfffdfb19f1c5bf6ad95a1b40cec2d35"><div class="ttname"><a href="format_8h.html#abfffdfb19f1c5bf6ad95a1b40cec2d35">format_set_diag_color</a></div><div class="ttdeci">void format_set_diag_color(lxw_format *format, lxw_color_t color)</div><div class="ttdoc">Set the diagonal cell border color.</div></div>
<div class="ttc" id="aformat_8h_html_a40e28394b961e69d4bee27579b4476e7a1fbd6761c4ccd57d98dfd59eaad9fde5"><div class="ttname"><a href="format_8h.html#a40e28394b961e69d4bee27579b4476e7a1fbd6761c4ccd57d98dfd59eaad9fde5">LXW_PATTERN_SOLID</a></div><div class="ttdeci">@ LXW_PATTERN_SOLID</div><div class="ttdef"><b>Definition:</b> format.h:235</div></div>
<div class="ttc" id="aworksheet_8h_html_ac208046e7a6d12cc87982422efa41b31"><div class="ttname"><a href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a></div><div class="ttdeci">lxw_error worksheet_write_string(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, const char *string, lxw_format *format)</div><div class="ttdoc">Write a string to a worksheet cell.</div></div>
<div class="ttc" id="aformat_8h_html_abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec"><div class="ttname"><a href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38baedd7412491d9f34fc5f947ada9d196ec">LXW_COLOR_RED</a></div><div class="ttdeci">@ LXW_COLOR_RED</div><div class="ttdef"><b>Definition:</b> format.h:217</div></div>
<div class="ttc" id="aworksheet_8h_html_ab9b7fb95e1bd9b0da70befd0d37a9173"><div class="ttname"><a href="worksheet_8h.html#ab9b7fb95e1bd9b0da70befd0d37a9173">worksheet_set_row</a></div><div class="ttdeci">lxw_error worksheet_set_row(lxw_worksheet *worksheet, lxw_row_t row, double height, lxw_format *format)</div><div class="ttdoc">Set the properties for a row of cells.</div></div>
<div class="ttc" id="aformat_8h_html_ae690004cd77f48646da07796b540c309"><div class="ttname"><a href="format_8h.html#ae690004cd77f48646da07796b540c309">format_set_rotation</a></div><div class="ttdeci">void format_set_rotation(lxw_format *format, int16_t angle)</div><div class="ttdoc">Set the rotation of the text in a cell.</div></div>
<div class="ttc" id="aworksheet_8h_html_ad9fc47d3beaa2ab4759414e8580c2289"><div class="ttname"><a href="worksheet_8h.html#ad9fc47d3beaa2ab4759414e8580c2289">worksheet_write_number</a></div><div class="ttdeci">lxw_error worksheet_write_number(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, double number, lxw_format *format)</div><div class="ttdoc">Write a number to a worksheet cell.</div></div>
<div class="ttc" id="aformat_8h_html_a61981b2080bfe6381ede5358ee05b05c"><div class="ttname"><a href="format_8h.html#a61981b2080bfe6381ede5358ee05b05c">format_set_font_color</a></div><div class="ttdeci">void format_set_font_color(lxw_format *format, lxw_color_t color)</div><div class="ttdoc">Set the color of the font used in the cell.</div></div>
<div class="ttc" id="aformat_8h_html_a449e2235a9088cc60233ae443acd2b1a"><div class="ttname"><a href="format_8h.html#a449e2235a9088cc60233ae443acd2b1a">format_set_font_name</a></div><div class="ttdeci">void format_set_font_name(lxw_format *format, const char *font_name)</div><div class="ttdoc">Set the font used in the cell.</div></div>
<div class="ttc" id="aformat_8h_html_ad35ee5445826bd93ec1bc0d489fc09db"><div class="ttname"><a href="format_8h.html#ad35ee5445826bd93ec1bc0d489fc09db">format_set_underline</a></div><div class="ttdeci">void format_set_underline(lxw_format *format, uint8_t style)</div><div class="ttdoc">Turn on underline for the format:</div></div>
<div class="ttc" id="aformat_8h_html_a4d5e924b1acd9571fd5e0fe2615e9f8fa7ca212fb42e5816bb81d7b96ff623082"><div class="ttname"><a href="format_8h.html#a4d5e924b1acd9571fd5e0fe2615e9f8fa7ca212fb42e5816bb81d7b96ff623082">LXW_BORDER_THIN</a></div><div class="ttdeci">@ LXW_BORDER_THIN</div><div class="ttdef"><b>Definition:</b> format.h:295</div></div>
<div class="ttc" id="autility_8h_html_ad510ac6df573d23203374e24dba373d2"><div class="ttname"><a href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a></div><div class="ttdeci">#define CELL(cell)</div><div class="ttdoc">Convert an Excel A1 cell string into a (row, col) pair.</div><div class="ttdef"><b>Definition:</b> utility.h:45</div></div>
<div class="ttc" id="aformat_8h_html_a99aea699cd7bb3c56a515c9c9e0caa69"><div class="ttname"><a href="format_8h.html#a99aea699cd7bb3c56a515c9c9e0caa69">format_set_indent</a></div><div class="ttdeci">void format_set_indent(lxw_format *format, uint8_t level)</div><div class="ttdoc">Set the cell text indentation level.</div></div>
<div class="ttc" id="aworkbook_8h_html_a279a5d7075d09a3931aae9782afede33"><div class="ttname"><a href="workbook_8h.html#a279a5d7075d09a3931aae9782afede33">workbook_add_format</a></div><div class="ttdeci">lxw_format * workbook_add_format(lxw_workbook *workbook)</div><div class="ttdoc">Create a new Format object to formats cells in worksheets.</div></div>
<div class="ttc" id="aformat_8h_html_a43ddbc77d637b04fdfbc45e96857d15a"><div class="ttname"><a href="format_8h.html#a43ddbc77d637b04fdfbc45e96857d15a">format_set_pattern</a></div><div class="ttdeci">void format_set_pattern(lxw_format *format, uint8_t index)</div><div class="ttdoc">Set the background fill pattern for a cell.</div></div>
<div class="ttc" id="aformat_8h_html_a135d94ec48564c997c5a78ca8b8861e2"><div class="ttname"><a href="format_8h.html#a135d94ec48564c997c5a78ca8b8861e2">format_set_hidden</a></div><div class="ttdeci">void format_set_hidden(lxw_format *format)</div><div class="ttdoc">Hide formulas in a cell.</div></div>
<!-- HTML footer for doxygen 1.8.20-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Copyright 2014-2020 John McNamara.
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
